JSON と XML ビュー

JsonViewXmlView を使用することで JSON と XML レスポンスを作成できるようになり、 それらは Cake\Controller\Component\RequestHandlerComponent と統合されます。

あなたのアプリケーションで RequestHandlerComponent を有効にして、 jsonxml またはいずれかの拡張子のサポートを有効にすることで、 自動的に新しいビュークラスを使用することが出来るようになります。 以降、このページでは JsonViewXmlView をデータビューと呼びます。

データビューを生成する方法は2つあります。 一つ目は _serialize キーを使用する方法、二つ目は通常のテンプレートファイルを使用する方法です。

あなたのアプリケーションでデータビューを有効化する

データビュークラスを使用する前に、 まず Cake\Controller\Component\RequestHandlerComponent をコントローラーでロードする必要があります。

public function initialize()
{
    ...
    $this->loadComponent('RequestHandler');
}

AppController で上記のようにすることで、コンテンツタイプによる自動切り替えが有効化されます。 viewClassMap 設定でコンポーネットを設定することで、カスタムクラスをマップしたり 他のデータ型をマップするも出来ます。

任意で ファイル拡張子のルーティング で json と xml 、もしくはどちらかの拡張子を有効化することが出来ます。 http://example.com/articles.json の様に、URL の末尾でファイルの拡張子として レスポンスタイプの名前を指定することで、 JSONXML もしくはそれ以外の特定の フォーマットビューにアクセスすることが出来ます。

デフォルトでは ファイル拡張子のルーティング が無効の場合、リクエストの Accept ヘッダーにより、 ユーザーにどのフォーマットをレンダリングするべきかが判断されます。例として、 JSON レスポンスを レンダリングするために使用される Accept の設定値は application/json です。

シリアライズキーをデータビューで使用する

_serialize キーは、データビューを使用する時に、どのビュー変数がシリアライズされるべきかを示す 特別なビュー変数です。json/xml に変換する前に独自のフォーマット処理が不要な場合、 これはコントローラーのアクションでテンプレートファイルを定義する手間を省いてくれます。

レスポンスを生成する前にビュー変数へ独自のフォーマット処理や操作が必要な場合は、 テンプレートファイルを使用する必要があります。 _serialize の値は、文字列かシリアライズしたいビュー変数の配列のどちらかになります。

namespace App\Controller;

class ArticlesController extends AppController
{
    public function initialize()
    {
        parent::initialize();
        $this->loadComponent('RequestHandler');
    }

    public function index()
    {
        // シリアライズする必要があるビュー変数をセットする
        $this->set('articles', $this->paginate());
        // JsonView がシリアライズするべきビュー変数を指定する
        $this->set('_serialize', 'articles');
    }
}

_serialize をビュー変数の配列として定義し結合することも出来ます。

namespace App\Controller;

class ArticlesController extends AppController
{
    public function initialize()
    {
        parent::initialize();
        $this->loadComponent('RequestHandler');
    }

    public function index()
    {
        // $articles と $comments を生成する何某かのコード

        // シリアライズする必要があるビュー変数をセットする
        $this->set(compact('articles', 'comments'));

        // JsonView がシリアライズするべきビュー変数を指定する
        $this->set('_serialize', ['articles', 'comments']);
    }
}

XmlView を使用するケースでは、配列として _serialize を定義することには最上位に <response> 要素が自動的に付与されるという利点があります。 _serialize と XmlView に 文字列を使用する時は、ビュー変数が最上位要素を一つ持つことに確認してください。 一つも最上位要素を持たない場合、XML の生成に失敗するでしょう。

テンプレートファイルをデータビューで使用する

最終的な出力の前にビュー変数に何かの処理を施したいケースでは、テンプレートファイルを 使用する必要があります。例えば、生成された HTML を要素として持つ記事があり、 JSON レスポンスからそれを取り除きたいとします。こういった状況ではビューファイルが役に立ちます。

// コントローラーのコード
class ArticlesController extends AppController
{
    public function index()
    {
        $articles = $this->paginate('Articles');
        $this->set(compact('articles'));
    }
}

// ビューのコード - src/Template/Articles/json/index.ctp
foreach ($articles as &$article) {
    unset($article->generated_html);
}
echo json_encode(compact('articles'));

より複雑な操作を行ったり、ヘルパーを整形に使用することも出来ます。データビュークラスは、 ビューファイルはシリアライズされたコンテンツを出力することを前提としているため、 レイアウトをサポートしません。

注釈

3.1.0 の AppController から、全ての XML/JSON リクエストに対して、 アプリケーションスケルトンの中で自動的に '_serialize' => true が追加されます。 そのためビューファイルを使用したい場合は、このコードを beforeRender コールバックから 取り除くか、 '_serialize' => false をセットする必要があります。

XML ビューの作成

class XmlView

デフォルトでは _serialize を使用する時、XmlView は <response> ノードでシリアル化されるビュー変数をラップします。 _rootNode ビュー変数を使用することで、このノードに別の名前を設定することが出来ます。

XmlView クラスは、XML の生成に使用するオプション(例: tags vs attributes )を 変更するための _xmlOptions 変数をサポートしています。

JSON ビューの作成

class JsonView

JsonView クラスは、JSON の生成に使用するビットマスクを変更するためための _jsonOptions 変数をサポートします。このオプションの有効な値は json_encode を参照してください。

例えば、一貫した JSON 形式で CakePHP エンティティーの検証エラーをシリアライズするには:

// コントローラーのアクションの中で、保存に失敗した時
$this->set('errors', $articles->errors());
$this->set('_jsonOptions', JSON_FORCE_OBJECT);
$this->set('_serialize', ['errors']);

JSONP レスポンス

JsonView を使用する時は、特別なビュー変数 _jsonp を使用することで JSONP レスポンスの返すことが出来ます。これに true を設定することで、ビュークラスに 「callback」 という名前のクエリー文字列パラメーターがセットされているかをチェックさせ、 それ同時に提供された関数名で JSON レスポンスをラップさせることが出来ます。 「callback」 の代わりにカスタムクエリー文字列パラメーターを使用したい場合は、 _jsonptrue の代わりの名前を指定してください。

使用例

リクエストのコンテンツタイプまたは拡張子によって、 RequestHandlerComponent が自動的にビューをセットするのに対して、あなたも同様にコントローラーのなかでビューマッピングを 操作することが出来ます。

// src/Controller/VideosController.php
namespace App\Controller;

use App\Controller\AppController;
use Cake\Network\Exception\NotFoundException;

class VideosController extends AppController
{
    public function export($format = '')
    {
        $format = strtolower($format);

        // ビューマッピングの形式
        $formats = [
          'xml' => 'Xml',
          'json' => 'Json',
        ];

        // 未知の形式の時はエラー
        if (!isset($formats[$format])) {
            throw new NotFoundException(__('Unknown format.'));
        }

        // ビューに出力形式をセット
        $this->viewBuilder()->className($formats[$format]);

        // データを取得
        $videos = $this->Videos->find('latest');

        // ビューにデータをセット
        $this->set(compact('videos'));
        $this->set('_serialize', ['videos']);

        // ダウンロードを指定
        // 3.4.0 より前は
        // $this->response->download('report-' . date('YmdHis') . '.' . $format);
        return $this->response->withDownload('report-' . date('YmdHis') . '.' . $format);
    }
}