出力形式の自動選択(ContextSwitch)
普段はブラウザから見るページの内容を、専用アプリやAJAXで処理する関係でHTML形式以外のフォーマットで出力して欲しくなる場合があります。各フォーマットごとにアクションを作成すれば対応は可能ですが、それでは手間がかかります。
ContextSwitchアクションヘルパーは、このように出力フォーマットを切り替えたい場合に便利です。この対応している出力フォーマットのことをコンテキストと呼びます。
ContextSwitchアクションヘルパーを利用する手順としては(1)コントローラのinitメソッドでどのアクションが(追加で)どのコンテキストに対応しているかを指定し、(2)その追加したコンテキストに対応したビュースクリプトを作成します。
例えば「index」コントローラの「context」アクションに、XML形式でもデータを出力させるようにします。そのためには、まずinitメソッドに次のように記述します。
function init()
{
/*(1)contextSwitchアクションヘルパーの取得 */
$contextSwitch = $this->_helper->getHelper('contextSwitch');
/*(2)アクションにフォーマットの追加 */
$contextSwitch->addActionContext('context', 'xml');
/*(3)contextSwitchの初期化 */
$contextSwitch->initContext();
}
まず(1)contextSwitchアクションヘルパーを取得した後、(2)どのアクションにどのフォーマットを追加するかを指定します。そして(3)contextSwitchアクションヘルパーの初期化を行います。
このXMLでの出力に対応するビュースクリプトも準備します。通常、contextアクションに対応するビュースクリプトは「context.phtml」ですが、この「.phtml」の前にフォーマットの「xml」を追加した「context.xml.phtml」ファイルを作成します。
<?php
echo $this->Doctype('XHTML1_STRICT');
?>
<text>Test</text>
このXML形式のデータを出力させるためにはアクセスする際、パラメータに「format」を指定します。これで「context.xml.phtml」で指定された内容で出力が行われます。
http://~/index/context/format/xml
▼
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><text>Test</text>
contextSwitchアクションヘルパーは、標準でXML形式とJSON形式の2種類のフォーマットに対応したコンテキストが準備されています。
| フォーマット名 | ヘッダ | 出力 |
| XML | text/xml | 標準では「~.xml.phtml」ビュースクリプトを描画 |
| JSON | application/json | 標準ではZend_Viewのオブジェクトの変数をJSON形式で出力 |
XML形式での出力は先程見た通りです。JSON形式は少し特殊で、デフォルトではビュースクリプトは必要ありません。その代わり、Zend_Viewのオブジェクトの変数をシリアライズしてJSON形式に変換したものを出力します。
