Tree¶

データを追加する¶

前のセクションでは、既存のデータを用い generatetreelist メソッドを使うことで 階層構造がどのように見えるかを確認しました。しかしながら、たとえ階層構造を持った データであっても、通常は他のモデルとまったく同じ方法でデータを追加します。 例は次の通りです。

// pseudo controller code
$data['Category']['parent_id'] = 3;
$data['Category']['name'] = 'スケート';
$this->Category->save($data);

Tree ビヘイビアを用いる場合、親 ID (parent_id) をセットする以外のことは 何も行う必要がありません。残りのことは Tree ビヘイビアが注意深く行ってくれます。 もし parent_id をセットしない場合は、Tree ビヘイビアはツリーに、 新たなトップレベルのエントリーを作成します。

// pseudo controller code
$data = array();
$data['Category']['name'] = '別の人たちのカテゴリ';
$this->Category->save($data);

上記の２つの短いコードを実行すると、ツリーは次のように変化します。

• 私のカテゴリ

  • 楽しみ

    • スポーツ

      • サーフィン

      • エクストリーム編み物

      • スケート New

    • 友達

      • ジェラルド

      • グウェンドリン

  • 仕事

    • 報告書

      • 年報

      • 状況

    • 出張

      • 国内

      • 海外

• 別の人たちのカテゴリ New

データを変更する¶

データを変更することは、新しいデータを追加することと同じぐらい透過的です。 何かデータを変更したいが、 parent_id は変更しない場合、階層構造にかかわる箇所は 何も変更されません。例は次の通りです。

// コントローラのコードの一部
$this->Category->id = 5; // 「エクストリーム編み物」の ID
$this->Category->save(array('name' => 'Extreme fishing'));

上記のコードは parent_id フィールドに何も影響をあたえません。 もし渡されたデータの中に parent_id が入っていても、 値に変更がなければ保存されませんし、階層構造も更新されません。 この結果、ツリーのデータは次ようになります。

• 私のカテゴリ

  • 楽しみ

    • スポーツ

      • サーフィン

      • エクストリームフィッシング Updated

      • スケート

    • 友達

      • ジェラルド

      • グウェンドリン

  • 仕事

    • 報告書

      • 年報

      • 状況

    • 出張

      • 国内

      • 海外

• 別の人たちのカテゴリ

ツリーの中でデータを移動することも簡潔に行えます。エクストリームフィッシングは スポーツではないが、別の人たちのカテゴリに属するとする場合、次のようにします。

// コントローラのコードの一部
$this->Category->id = 5; // 「エクストリームフィッシング」の ID
$newParentId = $this->Category->field(
  'id',
  array('name' => '別の人たちのカテゴリ')
);
$this->Category->save(array('parent_id' => $newParentId));

次のような構造に変更されることが正しい動作です。

• 私のカテゴリ

  • 楽しみ

    • スポーツ

      • サーフィン

      • スケート

    • 友達

      • ジェラルド

      • グウェンドリン

  • 仕事

    • 報告書

      • 年報

      • 状況

    • 出張

      • 国内

      • 海外

• 別の人たちのカテゴリ

  • エクストリームフィッシング Moved

データの削除¶

Tree ビヘイビアは、データの削除を管理するいくつかの方法を提供します。 もっともシンプルな例からはじめてみましょう。「報告書」カテゴリが不要であるとしましょう。 このカテゴリと それの子要素も全て 削除する場合、どのモデルであってもただ delete() をコールします。例は次の通りです。

// コントローラのコードの一部
$this->Category->id = 10;
$this->Category->delete();

カテゴリのツリーは次のように変更されます。

• 私のカテゴリ

  • 楽しみ

    • スポーツ

      • サーフィン

      • スケート

    • 友達

      • ジェラルド

      • グウェンドリン

  • 仕事

    • 出張

      • 国内

      • 海外

• 別の人たちのカテゴリ

  • エクストリームフィッシング

データの問合せと利用¶

階層構造になったデータを取り扱い操作するのは、ややこしい作業になりがちです。 コアの find メソッドに加え、ツリービヘイビアによって自由に使えるツリー構造の 順序変更をいくつか行えます。

class TreeBehavior

children($id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null)¶

パラメータ:

• $id -- 検索するためのレコードのID

• $direct -- 直下のノードのみを返すために true を設定します

• $fields -- 戻り値に含まれるフィールド名の文字列またはフィールドの配列

• $order -- ORDER BY の SQL 文字列

• $limit -- SQL の LIMIT 構文

• $page -- ページつけられた結果にアクセスするための引数

• $recursive -- 再帰的に関連付けられたモデルの深さのレベル数

children メソッドは列の主キー(id)の値を用いて、そのアイテムの子を返します。 デフォルトの順番はツリーに出現した順です。第二引数はオプションのパラメータで、 直下の子ノードのみを返すか否かを定義します。前のセクションのデータ使った例を 見てみましょう。

$allChildren = $this->Category->children(1); // 11個のフラットな配列
// -- または --
$this->Category->id = 1;
$allChildren = $this->Category->children(); // 11 個のフラットな配列

// 直下の子ノードのみを返す
$directChildren = $this->Category->children(1, true); // 2 個のフラットな
                                                      // 配列

注釈

再帰的な配列で取得したい場合は、 find('threaded') というようにしてください。

childCount($id = null, $direct = false)¶

children メソッドと同様に、 childCount には列の主キー (id) の値を 渡します。これにより主キーが指定されたノードの子の数が返されます。オプションの 第二引数では、直下の子ノードのみの数を返すか否かを定義できます。前の章のデータを 使った例を見てみましょう。

$totalChildren = $this->Category->childCount(1); // 11 を出力
// -- または --
$this->Category->id = 1;
$directChildren = $this->Category->childCount(); // 11 を出力

// このカテゴリの直下の子ノードだけの数
$numChildren = $this->Category->childCount(1, true); // 2 を出力

generateTreeList($conditions=null, $keyPath=null, $valuePath=null, $spacer= '_', $recursive=null)¶

パラメータ:

• $conditions -- find() と同様の検索条件オプションに使用

• $keyPath -- キーとして使用するフィールドのパス。例: "{n}.Post.id"

• $valuePath -- ラベルに使用するフィールドのパス。例: "{n}.Post.title"

• $spacer -- 各々の値の前に付ける深さを示すための文字列

• $recursive -- 関連付けられたレコードを取得する際の深さのレベル数

このメソッドは、 spacer オプションで指定したプレフィックスでインデントを 付け構造が分かるようにした find('list') に似たデータを返します。 以下は、このメソッドがどのような値を返すかの例です。

$treelist = $this->Category->generateTreeList();

出力結果:

array(
    [1] =>  "私のカテゴリ",
    [2] =>  "_楽しみ",
    [3] =>  "__スポーツ",
    [4] =>  "___サーフィン",
    [16] => "___スケート",
    [6] =>  "__友達",
    [7] =>  "___ジェラルド",
    [8] =>  "___グウェンドリン",
    [9] =>  "_仕事",
    [13] => "__出張",
    [14] => "___国内",
    [15] => "___海外",
    [17] => "別の人たちのカテゴリ",
    [5] =>  "_エクストリームフィッシング"
)

formatTreeList($results, $options=array())¶

バージョン 2.7 で追加.

パラメータ:

• $results -- find('all') の実行結果

• $options -- 設定するオプション配列

このメソッドは、あなたのデータ構造を示す spacer オプションで指定された ネストしたプレフィックスをつけて find('list') と似たデータを返します。

サポートされるオプション:

• keyPath: キーの文字列パス。例： "{n}.Post.id"

• valuePath: 値の文字列パス。例： "{n}.Post.title"

• spacer: 繰り返しの文字または文字列

例:

$results = $this->Category->find('all');
$results = $this->Category->formatTreeList($results, array(
    'spacer' => '--'
));

getParentNode()¶

この便利な関数は、その名前が意味する通り、あるノードの親ノードを返します。 ただし、指定したノードに親がない(つまりルートノードである)場合は、 false を返します。例は次の通りです。

$parent = $this->Category->getParentNode(2); //<- "楽しみ" の ID
// $parent は全てのカテゴリを含みます

getPath($id = null, $fields = null, $recursive = null)¶

トップのノードからたどって階層化されたデータのパス (path) を返します。 例においてカテゴリの「海外」までのパスは次のようになります。

• 私のカテゴリ

  • ...

  • 仕事

  • 出張

    • ...

    • 海外

「海外」の ID を使って getPath を実行すると、頂上からはじめて、 各親を順々に返します。

$parents = $this->Category->getPath(15);

// contents of $parents
array(
    [0] =>  array(
      'Category' => array('id' => 1, 'name' => '私のカテゴリ', ..)
    ),
    [1] =>  array(
      'Category' => array('id' => 9, 'name' => '仕事', ..)
    ),
    [2] =>  array(
      'Category' => array('id' => 13, 'name' => '出張', ..)
    ),
    [3] =>  array(
      'Category' => array('id' => 15, 'name' => '海外', ..)
    ),
)