Previous Next

レスポンスオブジェクト

使用法

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

$front->throwExceptions(true);

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

$response->sendResponse();

注意:

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

$front->returnResponse(true);
$response = $front->dispatch();

// 何かの処理、たとえばログの記録などを行ってから
// 結果を出力します
$response->sendResponse();

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

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

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

注意:

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

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

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

// dispatch の後に取得します
$front->dispatch();
$response = $front->getResponse();
if ($response->isException()) {
    // ログへの記録、メール送信など...
}

// あるいは、フロントコントローラの dispatch() の返り値を使用します
$front->returnResponse(true);
$response = $front->dispatch();

// 何かの処理...

// 最後に結果を表示します
$response->sendResponse();

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

$response->renderExceptions(true);
$front->dispatch($request, $response);

// あるいは
$front->returnResponse(true);
$response = $front->dispatch();
$response->renderExceptions();
$response->sendResponse();

// あるいは
$front->throwExceptions(true);
$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() が用意されています。

名前つきセグメント

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

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

// このプラグインクラスがフロントコントローラで登録済みであると仮定します
class MyPlugin extends Zend_Controller_Plugin_Abstract
{
    public function preDispatch(Zend_Controller_Request_Abstract $request)
    {
        $response = $this->getResponse();
        $view = new Zend_View();
        $view->setBasePath('../views/scripts');

        $response->prepend('header', $view->render('header.phtml'));
    }

    public function postDispatch(Zend_Controller_Request_Abstract $request)
    {
        $response = $this->getResponse();
        $view = new Zend_View();
        $view->setBasePath('../views/scripts');

        $response->append('footer', $view->render('footer.phtml'));
    }
}

// アクションコントローラの例
class MyController extends Zend_Controller_Action
{
    public function fooAction()
    {
        $this->render();
    }
}

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

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

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

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

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

  • 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 の場合はヘッダを送信しないなど) 名前つきセグメントに保存された内容の最終結果を返す機能を追加したりといったことが考えられます。

Previous Next
Zend Framework の紹介
概要
インストール
Learning Zend Framework
Zend Framework Quick Start
Zend Framework & MVC Introduction
Create Your Project
Create A Layout
Create a Model and Database Table
Create A Form
Congratulations!
Autoloading in Zend Framework
Introduction
Goals and Design
Basic Autoloader Usage
Resource Autoloading
Conclusion
Plugins in Zend Framework
Introduction
Using Plugins
Conclusion
Getting Started with Zend_Layout
Introduction
Using Zend_Layout
Zend_Layout: Conclusions
Getting Started Zend_View Placeholders
Introduction
Basic Placeholder Usage
Standard Placeholders
View Placeholders: Conclusion
Understanding and Using Zend Form Decorators
Introduction
Decorator Basics
Layering Decorators
Rendering Individual Decorators
Creating and Rendering Composite Elements
Conclusion
Getting Started with Zend_Session, Zend_Auth, and Zend_Acl
Building Multi-User Applications With Zend Framework
Managing User Sessions In ZF
Authenticating Users in Zend Framework
Building an Authorization System in Zend Framework
Getting Started with Zend_Search_Lucene
Zend_Search_Lucene Introduction
Lucene Index Structure
Index Opening and Creation
Indexing
Searching
Supported queries
Search result pagination
Getting Started with Zend_Paginator
Introduction
Simple Examples
Pagination Control and ScrollingStyles
Putting it all Together
Zend Framework リファレンス
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server
Zend_Application
導入
Zend_Application クイックスタート
Theory of Operation
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Barcode
導入
Barcode creation using Zend_Barcode class
Zend_Barcode Objects
Zend_Barcode Renderers
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
The Cache Manager
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGenerator リファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
Zend_Currency
Zend_Currency について
Using Zend_Currency
Options for currencies
What makes a currency?
Where is the currency?
How does the currency look like?
How much is my currency?
Calculating with currencies
Exchanging currencies
Additional informations on Zend_Currency
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Db_Table_Definition
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dojo build layer support
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
基本的な使用法
Previous Exceptions (前の例外)
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_Feed_Reader
Zend_Feed_Writer
Zend_Feed_Pubsubhubbub
Zend_File
Zend_File_Transfer
Zend_File_Transfer 用のバリデータ
Filters for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
Basic Usage
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
API概要
利用シナリオ
ツール
Zend_Ldap_Nodeを使用してLDAPツリーへのオブジェクト指向アクセス
LDAPサーバから情報を取得
LDIFへ、または、からのLDAPデータシリアライズ
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
サポートするロケール
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Using the Factory to Create a Log
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Markup
導入
さあ始めましょう
Zend_Markup パーサー
Zend_Markup レンダラー
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
導入
画面
Containers
Zend_Oauth
Introduction to OAuth
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
Interactive Features
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar
Zend_Queue
導入
使用例
フレームワーク
アダプタ
Zend_Queueのカスタマイズ
Stomp
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Serializer
Introduction
Zend_Serializer_Adapter
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Storage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2:リージョンおよび利用可能ゾーン
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_DeveloperGarden
Zend_Service_Flickr
Zend_Service_LiveDocx
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_WindowsAzure
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDLアクセッサ
自動検出
Zend_Tag
導入
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit
Zend_Test_PHPUnit_Db
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool
Using Zend_Tool On The Command Line
Extending Zend_Tool
Zend_Tool_Framework
導入
CLIツールの使用
アーキテクチャ
Zend_Tool_Frameworkを利用してプロバイダを作成する
出荷されたシステムプロバイダー
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
導入
プロジェクトを作成
Zend Toolプロジェクトプロバイダー
Zend_Tool_Project内部
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
ソースファイルの作成
翻訳用の追加機能
Plural notations for Translation
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
検証メッセージ
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
ZendX_Console_Process_Unix
ZendX_Console_Process_Unix
ZendX_JQuery
Introduction
ZendX_JQuery View Helpers
ZendX_JQuery Form Elements and Decorators
Zend Framework のシステム要件
導入
Zend Framework 移行上の注意
Zend Framework 1.10
Zend Framework 1.9
Zend Framework 1.8
Zend Framework 1.7
Zend Framework 1.6
Zend Framework 1.5
Zend Framework 1.0
Zend Framework 0.9
Zend Framework 0.8
Zend Framework 0.6
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework Documentation Standard
Overview
Documentation File Formatting
Recommendations
Zend Framework MVC アプリケーションのために推奨されるプロジェクト構造
概要
推奨されるプロジェクト・ディレクトリ構造
モジュール構造
リライト設定ガイド
Zend Framework パフォーマンスガイド
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報