Aura Framework controller はアクションメソッドドのためのAbstractPage
やリクエストを扱うContext
、HTTPレスポンスを転送するResponse
転送オブジェクトを含んだwebページコントローラーを作成するために必要なAura Web の拡張版です。(Response
転送オブジェクトはHTTPレスポンスそのものでは無い事に注意してください)
これにはコントローラにフック処理をするためのSignal
インターフェイスや複数のレンダリング方法を提供するRenderer
インタフェースも含まれます。
Aura\Framework\Web\Controller\AbstractPage
を拡張して独自のコントローラーを作成します。
ページコントローラーには実行サイクルがあります。
exec()
サイクルが実行されると …
まず preExec()
フックが全体の実行のために準備されます。
次に preAction()
フックがアクションのために準備されます。
action()
'action'
パラメータの値で決定されたメソッドが実行されます。
続いてpostAction()
がフックされ、
preRender()
フックがレンダリングのために準備されます。
render()
メソッドでプレゼンテーションがレンダリングされます(ディベロッパーが作成することもできます)
続いてpostRender()
がフックされ、
postExec()
は全体の実行の終わりにフックされます。
この時点で exec()
が呼ばれても何も起こりません。一致するアクションメソッドが無いからです。
ページコントローラーにアクションメソッドを追加するには必要な引数を追加したaction*()
メソッドを作成します。
レスポンスを操作するためには$this->response
転送オブジェクトを使います。重要なメソッドはのいくつかは以下のとおりです。
setContent()
: コンテント本体をセットします
setHeader()
: 単一のヘッダーをセットします
setCookie()
: 単一のcookieをセットします
setRedirect()
: Location:
ヘッダーをリダイレクトのためにセットします (デフォルトは '302 Found'
.)
setStatusCode()
と setStatusText()
はHTTPのステータスコードとメッセージをセットします
詳細については、 Response クラスを確認してください。
webのリクエスト状況は $this->context
オブジェクトで知る事ができます。重要なメソッドのいくつかは以下のとおりです。
getQuery()
: $_GET の値を取得します
getPost()
: $_POST の値を取得します
getFiles()
: $_FILES vの値を取得します
getInput()
: 生の php://input
の値を取得します
getJsonInput()
: 生の php://input
の値と json_decode()
の値を取得します
isGet()
, isPut()
, isXhr()
, 等: メソッドが GET
, PUT
, あるいは Xml-HTTP-Request
等かを返します
詳細については、 Context クラスご確認ください。 “terms” クエリー文字列をつかった”search” アクションのコード例は以下の様になるでしょう。
'?terms=foo+bar+baz'
というクエリーのついたURIが与えられると $terms
変数は 'foo bar baz'
になります。もしクエリーに 'terms'
がないと$terms
はnullになります。
$this->accept
オブジェクトをつかってクライアントが何をアクセプトしているかを知る事ができます。
getContentType()
: 利用可能なメディアタイプを返します
getCharset()
: 利用可能なキャラクターセットを返します
getEncoding()
: 利用可能なエンコーディングを返します
getLanguage()
: 利用可能な言語を返します
通常はResponse
の内容をアクションメソッドで直接操作したいとは思わないでしょう。ほとんどの場合は、アクションメソッドの内部でデータを集めて、表示のためにレンダリングシステムにデータを渡します。AbstractPage
は$data
プロパティとRenderer
を提供します。 $data
プロパティを単純に使用する例は、次のとおりです。
適切なテンプレートでレンダリングするためには、レンダリングに必要なビューとレイアウトのアサインが必要です。
レンダーに必要な値はこのようにアサインします。 $this->view = 'viewname'
レイアウトに必要なアサインはこのようにします。$this->layout = 'layout-name'
.
ここでは、二つのことを追加する必要があります。 Add your controller to the map in the config/default.php
ファイルでコントローラーをマップして加える事です。
.
上記コントローラで指定した同じ名前でルートを追加します。
ルートの詳細については、ルーティングの章を読んでみてください。