Documentation

レスポンスオブジェクト - Zend_Controller

レスポンスオブジェクト

使用法

レスポンスオブジェクトは、 リクエストオブジェクト と対になるものです。 その目的は、コンテンツやヘッダを収集し、それを返すことです。 さらに、フロントコントローラで捕捉した例外はすべてレスポンスオブジェクトに渡されます。 これにより、例外の処理がやりやすくなります。 この挙動を変更するには Zend_Controller_Front::throwExceptions(true) と設定します。

  1. $front->throwExceptions(true);

ヘッダを含むレスポンス出力を送信するには、 sendResponse() を使用します。

  1. $response->sendResponse();

Note: デフォルトでは、リクエストのディスパッチに終了した時点でフロントコントローラが sendResponse() をコールします。通常はこれをコールする必要はありません。 しかし、テスト中などにレスポンスの内容を操作したい場合は、 returnResponse フラグを Zend_Controller_Front::returnResponse(true) と設定することでこの振る舞いを変更できます。

  1. $front->returnResponse(true);
  2. $response = $front->dispatch();
  3.  
  4. // 何かの処理、たとえばログの記録などを行ってから
  5. // 結果を出力します
  6. $response->sendResponse();

開発者は、アクションコントローラの中でレスポンスオブジェクトを使用しなければなりません。 出力を直接レンダリングしたり直接ヘッダを送信したりするのではなく、 それらをレスポンスオブジェクトに格納するようにします。

  1. // アクションコントローラのアクション内で、
  2. // ヘッダを設定します
  3. $this->getResponse()
  4.     ->setHeader('Content-Type', 'text/html')
  5.     ->appendBody($content);

こうすることで、すべてのヘッダを一度に送信し、 その後でコンテンツを表示することができます。

Note: アクションコントローラで ビューの統合 を使用する場合は、 レンダリングされたビュースクリプトの内容をレスポンスオブジェクトに設定する必要はありません。 Zend_Controller_Action::render() がデフォルトでこれを行います。

アプリケーションで例外が発生したかどうかを調べるには、 レスポンスオブジェクトの isException() フラグを調べます。例外を取得するには getException() を使用します。さらに、独自のレスポンスオブジェクトを作成して、 エラーページへのリダイレクトや例外メッセージのログ出力、 例外をわかりやすく表示する (開発用) などを行うことができます。

レスポンスオブジェクトは、フロントコントローラの dispatch() から受け取ることになります。あるいは、 出力のレンダリングを行わない状態のレスポンスオブジェクトを フロントコントローラから受け取ることもできます。

  1. // dispatch の後に取得します
  2. $front->dispatch();
  3. $response = $front->getResponse();
  4. if ($response->isException()) {
  5.     // ログへの記録、メール送信など...
  6. }
  7.  
  8. // あるいは、フロントコントローラの dispatch() の返り値を使用します
  9. $front->returnResponse(true);
  10. $response = $front->dispatch();
  11.  
  12. // 何かの処理...
  13.  
  14. // 最後に結果を表示します
  15. $response->sendResponse();

デフォルトでは、例外メッセージは表示されません。 この挙動をオーバーライドするには renderExceptions() メソッドを使用するか、あるいは上で示したようにフロントコントローラで throwExceptions() を有効にします。

  1. $response->renderExceptions(true);
  2. $front->dispatch($request, $response);
  3.  
  4. // あるいは
  5. $front->returnResponse(true);
  6. $response = $front->dispatch();
  7. $response->renderExceptions();
  8. $response->sendResponse();
  9.  
  10. // あるいは
  11. $front->throwExceptions(true);
  12. $front->dispatch();

ヘッダの操作

先ほど説明したように、レスポンスオブジェクトの役割のひとつは HTTP レスポンスヘッダを発行することです。 このために、さまざまなメソッドが用意されています。

  • canSendHeaders() を使用して、 ヘッダがすでに送信されているかどうかを調べます。 オプションのフラグで、ヘッダが送信済みの場合に例外をスローするかどうかを指定します。 この設定は、プロパティ headersSentThrowsExceptionFALSE にすることで上書きできます。

  • setHeader($name, $value, $replace = false) を使用して、個々のヘッダを設定します。デフォルトでは、 同名のヘッダがすでに存在した場合に既存のヘッダを置換することはありません。 しかし、$replaceTRUE に設定すると、 既存のヘッダを上書きするようになります。

    ヘッダを設定する前に、このメソッドは canSendHeaders() を使用して ヘッダが現時点で送信済みでないかどうか、例外をスローするかどうかを調べます。

  • setRedirect($url, $code = 302) は、 リダイレクト用の HTTP Location ヘッダを設定します。 HTTP ステータスコードを指定した場合は、そのコードを使用します。

    内部的には、このメソッドは $replace フラグをオンにして setHeader() をコールしています。

  • getHeaders() は、すべてのヘッダを配列で返します。 個々の配列の要素は、'name' および 'value' のふたつのキーを持つ配列となります。

  • clearHeaders() は登録済みのヘッダをすべて削除します。

  • setRawHeader() を使用して、キー/値 の組になっていないヘッダを設定します。 たとえば HTTP status ヘッダなどがこれにあたります。

  • getRawHeaders() は、登録済みの生のヘッダを返します。

  • clearRawHeaders() は、登録済みの生のヘッダを消去します。

  • clearAllHeaders() は、キー/値 のペアである通常のヘッダと 生のヘッダの両方を消去します。

これらのメソッドのほかに、現在のリクエストの HTTP レスポンスコードを設定したり取得したりするメソッドとして setHttpResponseCode()getHttpResponseCode() が用意されています。

クッキーのヘッダーを設定

You can inject HTTP Set-Cookie headers into the response object of an action controller by using the provided header class Zend_Http_Header_SetCookie

コンストラクタの引数

The following table lists all constructor arguments of Zend_Http_Header_SetCookie in the order they are accepted. All arguments are optional, but name and value must be supplied via their setters if not passed in via the constructor or the resulting Set-Cookie header be invalid.

  • $name: クッキーの名前

  • $value: クッキーの値

  • $expires: The time the cookie expires

  • $path: The path on the server in which the cookie will be available

  • $domain: The domain to restrict cookie to

  • $secure: boolean indicating whether cookie should be sent over an unencrypted connection (false) or via HTTPS only (true)

  • $httpOnly: boolean indicating whether cookie should be transmitted only via the HTTP protocol

  • $maxAge: The maximum age of the cookie in seconds

  • $version: The cookie specification version

Example #1 Populate Zend_Http_Header_SetCookie via constructor and add to response

  1. $this->getResponse()->setRawHeader(new Zend_Http_Header_SetCookie(
  2.     'foo', 'bar', NULL, '/', 'example.com', false, true
  3. ));

Example #2 Populate Zend_Http_Header_SetCookie via setters and add to response

  1. $cookie = new Zend_Http_Header_SetCookie();
  2. $cookie->setName('foo')
  3.        ->setValue('bar')
  4.        ->setDomain('example.com')
  5.        ->setPath('/')
  6.        ->setHttponly(true);
  7. $this->getResponse()->setRawHeader($cookie);

名前つきセグメント

レスポンスオブジェクトでは「名前つきセグメント」をサポートしています。 これにより、本文部だけを別のセグメントに切り分けて、 指定した順序で出力したりといったことができるようになります。 内部的にはコンテンツは配列として保存され、 さまざまなメソッドを使用してその配列にアクセスできるようになります。

例として、 preDispatch() フックメソッドで レスポンスオブジェクトにヘッダを追加し、 アクションコントローラで本文を追加して、 最後に postDispatch() フックメソッドでフッタを追加することを考えてみましょう。

  1. // このプラグインクラスがフロントコントローラで登録済みであると仮定します
  2. class MyPlugin extends Zend_Controller_Plugin_Abstract
  3. {
  4.     public function preDispatch(Zend_Controller_Request_Abstract $request)
  5.     {
  6.         $response = $this->getResponse();
  7.         $view = new Zend_View();
  8.         $view->setBasePath('../views/scripts');
  9.  
  10.         $response->prepend('header', $view->render('header.phtml'));
  11.     }
  12.  
  13.     public function postDispatch(Zend_Controller_Request_Abstract $request)
  14.     {
  15.         $response = $this->getResponse();
  16.         $view = new Zend_View();
  17.         $view->setBasePath('../views/scripts');
  18.  
  19.         $response->append('footer', $view->render('footer.phtml'));
  20.     }
  21. }
  22.  
  23. // アクションコントローラの例
  24. class MyController extends Zend_Controller_Action
  25. {
  26.     public function fooAction()
  27.     {
  28.         $this->render();
  29.     }
  30. }

上の例で /my/foo をコールすると、 レスポンスオブジェクトに最終的に格納されるコンテンツは次のようになります。

  1.     'header'  => ..., // ヘッダの内容
  2.     'default' => ..., // MyController::fooAction() が作成した本文
  3.     'footer'  => ...  // フッタの内容
  4. );

これをレンダリングすると、配列に要素が追加された順に表示されます。

名前つきセグメントを操作するメソッドには、以下のようなものがあります。

  • setBody() の二番目のパラメータである $name に、セグメント名を渡すことができます。 セグメント名を指定すると、指定したセグメントの内容を上書きします (存在しない場合は新たに作成し、body 配列に追加します)。 setBody() にセグメント名を指定しなかった場合は、 配列全体を初期化します。

  • appendBody() also allows you to pass a second value, $name, indicating a named segment. If you provide a segment name it will append the supplied content to the existing content in the named segment, or create the segment if it does not exist (appending to the body array by default). appendBody() でセグメント名を省略した場合は、it will append the supplied content to the named segment 'default', creating it if it does not already exist.

  • prepend($name, $content) は、 $name という名前のセグメントを作成して、 それを配列の先頭に追加します。同じ名前のセグメントが存在する場合は、 まずそれを削除してから追加します(つまり、既存のものを上書きします)。

  • append($name, $content) は、 $name という名前のセグメントを作成して、 それを配列の最後に追加します。同じ名前のセグメントが存在する場合は、 まずそれを削除してから追加します(つまり、既存のものを上書きします)。

  • insert($name, $content, $parent = null, $before = false) は、$name という名前のセグメントを作成します。 $parent セグメントを指定すると、 新しいセグメントはそのセグメントの前か後ろ ($before の値で決まります) に配置されます。同じ名前のセグメントが存在する場合は、 まずそれを削除してから追加します(つまり、既存のものを上書きします)。

  • clearBody($name = null)$name を指定すると、その名前のセグメントを消去します (省略した場合は、配列全体を消去します)。

  • getBody($spec = false)$spec にセグメント名を指定すると、そのセグメントを取得できます。 $specFALSE を指定すると、 すべてのセグメントの内容を順番に連結した結果を文字列で返します。 $specTRUE を指定すると、本文の配列を返します。

レスポンスオブジェクト内での例外の検査

先ほど説明したように、デフォルトでは ディスパッチ中に発生した例外はレスポンスオブジェクトに登録されます。 例外はスタックに登録されるので、発生した例外はすべて保持することができます。 アプリケーションの例外、ディスパッチ処理の例外、プラグインの例外などなど……。 特定の例外の内容を調べたり例外をログに記録したりしたい場合は、 レスポンスオブジェクトの例外用 API を使用します。

  • setException(Exception $e) は、例外を登録します。

  • isException() は、例外が登録されているかどうかを調べます。

  • getException() は、例外スタック全体を返します。

  • hasExceptionOfType($type) は、特定のクラスの例外がスタックに登録されているかどうかを調べます。

  • hasExceptionOfMessage($message) は、指定したメッセージを含む例外が スタックに登録されているかどうかを調べます。

  • hasExceptionOfCode($code) は、指定したコードを含む例外が スタックに登録されているかどうかを調べます。

  • getExceptionByType($type) は、指定したクラスの例外をスタックからすべて取り出します。 そのクラスの例外が見つからなかった場合は FALSE を返し、 見つかった場合は例外の配列を返します。

  • getExceptionByMessage($message) は、指定したメッセージを含む例外をスタックからすべて取り出します。 そのクラスの例外が見つからなかった場合は FALSE を返し、 見つかった場合は例外の配列を返します。

  • getExceptionByCode($code) は、指定したコードを含む例外をスタックからすべて取り出します。 そのクラスの例外が見つからなかった場合は FALSE を返し、 見つかった場合は例外の配列を返します。

  • renderExceptions($flag) は、例外が発生したかどうかを表すフラグを設定します。

レスポンスオブジェクトのサブクラスの作成

レスポンスオブジェクトの役割は、 さまざまなアクションやプラグインからヘッダやコンテンツを収集し、 それをクライアントに返すことです。 さらに、処理中に発生したエラーの内容も収集します。 これはそのまま返すこともありますし、あるいはユーザから見えないように隠すこともあります。

レスポンスクラスの基底クラスは Zend_Controller_Response_Abstract です。レスポンスクラスを作成する際には、 このクラスあるいはその派生クラスのいずれかを継承しなければなりません。 このクラスが提供するメソッドについては、先ほど説明しました。

レスポンスオブジェクトのサブクラスを作成する理由としては、 リクエストされた環境に応じて出力内容を変えたり (たとえば CLIPHP-GTK の場合はヘッダを送信しないなど) 名前つきセグメントに保存された内容の最終結果を返す機能を追加したりといったことが考えられます。

Copyright

© 2006-2021 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts