magic-core
[ class tree: magic-core ] [ index: magic-core ] [ all elements ]

Class: Action

Source Location: /core/helper/base/Action.php

Class Overview


Actionの基底クラスです.


Author(s):

  • T.Okumura

Version:

  • 1.0.0

Variables

Methods



Class Details

[line 27]
Actionの基底クラスです.

アプリケーションには、最低一つ以上のActionクラスが必要です。
アプリケーションのActionクラスは、必ずこのクラスを継承して作成してください。 Actionクラスが正常に終了した場合は、必ず下記の何れか

を返すようにしてください。




Tags:

author:  T.Okumura
version:  1.0.0


[ Top ]


Class Variables

$error =  NULL

[line 52]

ActionErrorクラスを保持します.



Tags:

access:  protected

Type:   ActionError


[ Top ]

$file =  NULL

[line 47]

HttpFileクラスを保持します.



Tags:

access:  protected

Type:   HttpFile


[ Top ]

$flash =  NULL

[line 57]

HttpFlashクラスを保持します.



Tags:

access:  protected

Type:   HttpFlash


[ Top ]

$request =  NULL

[line 32]

HttpRequestクラスを保持します.



Tags:

access:  protected

Type:   HttpRequest


[ Top ]

$response =  NULL

[line 37]

HttpResponseクラスを保持します.



Tags:

access:  protected

Type:   HttpResponse


[ Top ]

$session =  NULL

[line 42]

HttpSessionクラスを保持します.



Tags:

access:  protected

Type:   HttpSession


[ Top ]



Class Methods


constructor __construct [line 61]

Action __construct( )

コンストラクタ.



Tags:

access:  public


[ Top ]

method inject [line 73]

void inject( string $property, mixed $value)

Actionクラスのプロパティにinjectします.

自動的にinjectさせるために、プロパティのスコープは 親クラスに対して可視(publicまたはprotected)でなければいけません。




Tags:

final:  
access:  public


Parameters:

string   $property   inject対象のプロパティ名
mixed   $value   injectするオブジェクト

[ Top ]

method intialize [line 84]

void intialize( HttpRequest $request, HttpSession $session)

初期処理.

自身のプロパティに値を設定、または初期化し、 Action::intializeAction()をコールします。




Tags:

final:  
access:  public


Parameters:

HttpRequest   $request  
HttpSession   $session  

[ Top ]

method intializeAction [line 104]

void intializeAction( )

クラスの初期処理.

Action::intialize()の後に、 フレームワークによってコールされます。
アプリケーション側で共通のクラス初期処理を実装したい場合は、 このファンクションをオーバーライドしてください。
HttpRequestクラスやHttpSessionクラスは、 すでに利用できる状態です。




Tags:

access:  protected


[ Top ]

method intializeMethod [line 121]

mixed intializeMethod( )

最初にコールされるファンクション.

これは、エントリポイントのファンクションがコールされる前にコールされます。
このタイミングで、初めてHttpFlashクラスが利用できます。
なぜなら、アプリケーション側がすべてのページにおいて、 セッションを必要とするかどうかの判断は、フレームワークにはできないからです。
すべてのページにセッションが必要な場合は、Controllerクラスでスタートさせても構いませんが、 ページごとに処理を分ける場合は、少なくともAction::intializeAction()ファンクションで、 セッションをスタートさせておく必要があります。
エントリポイントのファンクションを引き続きコールする場合には、NULLを返す必要があります。
そうでなければ、適切なActionResultを返すように実装してください。




Tags:

return:  処理を続行するにはNULL、そうでなければActionResultクラス
access:  protected


[ Top ]

method invoke [line 135]

ActionResult invoke( string $method)

アプリケーション側のエントリポイントをコールします.

セッションが開始されていれば、HttpFlashクラスを準備してから、 Action::intializeMethod()をコールします。
処理を続行する必要があれば、エントリポイントのファンクションをコールします。




Tags:

return:  Actionクラスの実行結果
throws:  MagicException ActionResultクラスが返されなかった場合
access:  public


Parameters:

string   $method   エントリポイントのファンクション名

[ Top ]


Documentation generated on Fri, 16 Dec 2011 11:13:38 +0100 by phpDocumentor 1.4.3