cakephp3 ブックマークチュートリアルの Collection

Question

お世話になります。
cakephp3のブックマークチュートリアルを勉強しています。
こちらのサイトで勉強しています。
http://book.cakephp.org/3.0/ja/tutorials-and-examples/bookmarks/part-two.html

このサイトの「計算済みフィールドを追加」の記述について詳しくお聞きしたいと思います。
コードの内容は、記事のタグ登録の際に、コンマで繋がれたタグを分ける機能だと思います。

protected function _getTagString()
{
if (isset($this->_properties['tag_string'])) {
return $this->_properties['tag_string'];
}
if (empty($this->tags)) {
return '';
}
$tags = new Collection($this->tags);
$str = $tags->reduce(function ($string, $tag) {
return $string . $tag->title . ', ';
}, '');
return trim($str, ', ');
}

このソースコードで以下の記述がよくわかりません。

$tags = new Collection($this->tags);
$str = $tags->reduce(function ($string, $tag) {
return $string . $tag->title . ', ';
}, '');

コレクションの意味や、reduce というメソッドに関数が入っている構造の解説を頂きたいと思います。
できれば、各変数の意味（例えば、function ($string)の$stringとは？）を具体的に教えて頂けると助かります。

Answer 1

この処理はタグの配列を、カンマ区切りの一つの文字列に変換する処理です。

Collectionクラスは、配列を操作するクラスです。
Collectionはnewするときに引数に配列を受け取ります。ここではタグの配列を渡しています。
reduce関数は、配列の個々の要素を順次処理して、1つの値にします。ここでは文字列にしたいのです。
reduce関数の引数は2つあり、第一引数は無名関数です。第二引数は初期値です。ここでは文字列の初期値は空文字列です。reduce関数は、配列の要素の数だけ、無名関数を実行します。
無名関数の引数は2つあり、第一引数の$stringは、ここまで処理した文字列が入っています。第二引数の$tagはタグの配列の要素です。
無名関数内では、今までの$stringに$tag->titleを文字列結合して、最後にカンマを結合してreturnしています。このreturnした値が次の要素の処理では引数$stringの値としてまた受け取ります。

以下のように関数内にdebugを入れると各値が出力できるので、どのように処理しているかわかると思います。

$tags = new Collection($this->tags); 
$str = $tags->reduce(function ($string, $tag) { 
debug($string);
debug($tag);
return $string . $tag->title . ', '; 
}, '');

ぶっちゃけ、こんな処理はforeachとかを使ったほうが簡単でわかりやすく実装できますが、Cakephpチュートリアルでは、Collectionクラスがあることを学ぶためにわざわざ使っているんだと思います。ちなみに自分は一度もColletionクラス使ったことないですね...。

あと、マニュアルに詳細が載っています。ただし、まだ日本語訳されていないので、英語のみです。

Comments

[blossan]

カンマ区切りの一つの文字列に変換する処理というのは、どのような処理でしょうか？
[a],[b],[c]⇒[a,b,c]というイメージでしょうか？
私は入力する時に、,区切りでタグを入力していたので、一つの文字列にすると、タグテーブルに保存する時に不便だとイメージしていたので、少し驚いています。
ちなみに、この_getTagStringとは、どのタイミングで呼ばれるのでしょうか？
また、、_getTagStringと、前に「_」とついているのは、private のような適用範囲を設定している意味であっていますか？

[popobot]

> [a],[b],[c]⇒[a,b,c]というイメージでしょうか？
そういうイメージです。

> ちなみに、この_getTagStringとは、どのタイミングで呼ばれるのでしょうか？
チュートリアルに書いてありますが、$bookmark->tag_stringでアクセスするとこの関数が実行されて、カンマ区切りで文字列になった値が取得できると思います。

> また、、_getTagStringと、前に「_」とついているのは、private のような適用範囲を設定している意味であっていますか？
これはprotectedな関数ですね。protectedな関数に「_」をつけることはぷろじぇくとによってはあります。別に必須ではないですが、Entityにget系の関数を追加するときはそうしないと行けないのがCakeの規約です。なお、privateな関数は「__」をつけるというのがよくあります。

[blossan]

丁寧な解説ありがとうございます。

[popobot]

1点補足

> 私は入力する時に、,区切りでタグを入力していたので、一つの文字列にすると、タグテーブルに保存する時に不便だとイメージしていたので、少し驚いています。

保存するときには別のbeforeSaveの処理でタグ区切りの文字列をもとの配列に戻す処理がありますので、実際には配列にして保存しています。
http://book.cakephp.org/3.0/ja/tutorials-and-examples/bookmarks/part-two.html#id11

カンマ区切りの文字列を生成する理由は、表示するときに配列だと不便なので、Entityで文字列に置き換えたものをビュー側で簡単に取得できるようにするためです。
また、カンマ区切りの文字列で入力されたときも同様にタグを保存できるようにもしています。

[blossan]

補足ありがとうございます。