cakephp3 $this-set('_serizlize',['変数名']); についてです。

Question

お世話になります。
コントローラーからビューへ値を渡す際に、

$this->set()を使います。
あるサンプルでは、

$this-set(compact('categories'));

という感じで、カテゴリーの値を渡しています。
その際、追加で、

$this-set('_serizlize',['categorise']);

という記述があり、これがどういう意味なのかを教えていただきたいと思います。
すでに、set()でcategoryは渡され、ビュー側の方でも、
「_serizlize」
という表記が見当たりません。

仮に、別の意味だとしても、すでにset()で値を渡した後に、渡した変数名と同じset()が使われる理由がわかりません。
回答お願いします。

Answer 1

通常、ブラウザでサイトにアクセスした場合はHTMLを返しますが、
javascriptなどで動的に(AJAXを使って)APIを実行して、データを取得したい場合にserializeにセットした値が使われます。
以下のサイトにシンプルなサンプルがあるので、見てみるとわかるかもしれません。
cakePHP3でAPIを叩く！

bakeで作成したコードの場合、勝手に_serializeをセットするコードができますが、通常HTMLだけを返す処理では不要です。

余談ですが、_serializeですね。スペルが少し違っています

Comments

[blossan]

この場合、javascript用に
$this->set('customers', $customers);//通常
$this->set('_serialize', ['customers'])//javascript用
それぞれ用意していることになるのでしょうか？

[popobot]

以下はView側に渡す値を設定しています。HTMLでもAPI用にも使われます。
$this->set('customers', $customers);
以下はAPI用にどの変数を使うかを定義しています。
$this->set('_serialize', ['customers']);
もし、$this->set('users', $users);というのもあり、このusersも返したいなら、以下のようにします。
$this->set('_serialize', ['customers', 'users']);

Answer 2

CakePHP3の仕様です。
通常はViewで指定したHTMLフォーマットを返答する為、そのViewの中で使う変数として$this->set()を使いますが。
CakePHPでは、返答するデータフォーマットをHTMLではなくJSONやXMLにする事が可能です。
そして、逐一Viewを作ってJSONフォーマットに整えたりせずとも、手続き通りの記法を取れば、CakePHPが勝手にJSONやXMLにフォーマットしたデータを返してくれる仕組みがあります。
それがまさに今回の_serializeです。

詳細はCookBook等ご参照ください。
http://book.cakephp.org/3.0/en/views/json-and-xml-views.html

$this->set('customers', $customers);
$this->set('_serialize', ['customers']);

という形でデータを渡すと、customersをキーとして、$costomersの中身を値とするJSONデータを作って、返答してくれる仕組みが用意されているわけです。