ツリー¶

データを追加する¶

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

// コントローラのコードの一部
$data['Category']['parent_id'] =  3;
$data['Category']['name'] =  'スケート';
$this->Category->save($data);

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

// コントローラのコードの一部
$data = array();
$data['Category']['name'] =  '別の人のカテゴリ';
$this->Category->save($data);

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

• カテゴリ

  • 楽しみ

    • スポーツ

      • サーフィン

      • エクストリーム編み物

      • スケート New

    • 友人

      • ジェラルド

      • グウェンドリン

  • 仕事

    • 報告書

      • 年次

      • 状態

    • 出張

      • 国内

      • 国外

• 別の人のカテゴリ New

データを変更する¶

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

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

上述のコードは 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

データの削除¶

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

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

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

• カテゴリ

  • 楽しみ

    • スポーツ

      • サーフィン

      • スケート

    • 友人

      • ジェラルド

      • グウェンドリン

  • 仕事

    • 出張

      • 国内

      • 国外

• 別の人のカテゴリ

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

データの問合せと利用¶

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

ツリービヘイビアのメソッドのほとんどは、 lft に依存してデータを並び替え、それを返します。もし find() メソッドをコールするときに lft で並び替えなかったり、ツリービヘイビアのメソッドに並び替えのための値を渡すと、望ましくない結果が返ってくるでしょう。

$allChildren = $this->Category->children(1); // 11アイテムをフラットな配列で返す
// -- または --
$this->Category->id = 1;
$allChildren = $this->Category->children(); // 11アイテムをフラットな配列で返す

// 直接の子のみ返す
$directChildren = $this->Category->children(1, true); // 2アイテムをフラットな配列で返す

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

// このカテゴリの直接の子のみ数える
$numChildren = $this->Category->childCount(1, true); // 2 を出力する

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

$parent = $this->Category->getparentnode(2); //<- 「楽しみ」の ID
// $parent にはカテゴリについての情報が入っている

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

// $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' => '国外', ..)),
)

moveDown¶

ツリーの中で一つのノードを位置を下げる(葉ノードに近づける)ために使用します。移動する要素の ID と、そのノードを下げる階層の数を正の整数で与えてください。指定したノードの子ノードも、全て移動されます。

次のものは、特定のノードの位置を下げる「Categories」という名のコントローラアクションの例です。

function movedown($name = null, $delta = null) {
        $cat = $this->Category->findByName($name);
        if (empty($cat)) {
            $this->Session->setFlash($name . 'という名のカテゴリが存在しません。');
            $this->redirect(array('action' => 'index'), null, true);
        }

        $this->Category->id = $cat['Category']['id'];

        if ($delta > 0) {
            $this->Category->moveDown($this->Category->id, abs($delta));
        } else {
            $this->Session->setFlash('フィールドの位置を下げる数を入力してください。');
        }

        $this->redirect(array('action' => 'index'), null, true);
    }

例えば「Sport」というカテゴリを一段下げたい場合は、「/categories/movedown/Sport/1」というリクエストを行ってください。

moveUp¶

ツリーの中で一つのノードを位置を上げる(根ノードに近づける)ために使用します。移動する要素の ID と、そのノードを上げる階層の数を正の整数で与えてください。全ての子ノードも、全て移動されます。

次のものは、ノードの位置を上げる「Categories」という名のコントローラアクションの例です。

function moveup($name = null, $delta = null){
        $cat = $this->Category->findByName($name);
        if (empty($cat)) {
            $this->Session->setFlash($name . 'という名のカテゴリが存在しません。');
            $this->redirect(array('action' => 'index'), null, true);
        }

        $this->Category->id = $cat['Category']['id'];

        if ($delta > 0) {
            $this->Category->moveup($this->Category->id, abs($delta));
        } else {
            $this->Session->setFlash('カテゴリの位置を上げる数を入力してください。');
        }

        $this->redirect(array('action' => 'index'), null, true);

    }

例えば「Gwendolyn」というカテゴリを一段上げたい場合は、「/categories/moveup/Gwendolyn/1」というリクエストを行ってください。これで、友人の並び順は Gwendolyn, Gerald となりました。

removeFromTree¶

removeFromTree($id=null, $delete=false)

Using this method wil either delete or move a node but retain its sub-tree, which will be reparented one level higher. It offers more control than `delete() </ja/view/1316/delete>`_, which for a model using the tree behavior will remove the specified node and all of its children.

Taking the following tree as a starting point:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Extreme knitting

      • Skating

Running the following code with the id for 'Sport'

$this->Node->removeFromTree($id);

The Sport node will be become a top level node:

• My Categories

  • Fun

    • Surfing

    • Extreme knitting

    • Skating

• Sport Moved

This demonstrates the default behavior of removeFromTree of moving the node to have no parent, and re-parenting all children.

If however the following code snippet was used with the id for 'Sport'

$this->Node->removeFromTree($id,true);

The tree would become

• My Categories

  • Fun

    • Surfing

    • Extreme knitting

    • Skating

This demonstrates the alternate use for removeFromTree, the children have been reparented and 'Sport' has been deleted.

reorder¶

このメソッドは階層化されたデータを並び替えるために使用します。

Recover¶

recover(&$model, $mode = 'parent', $missingParentAction = null)

The mode parameter is used to specify the source of info that is valid/correct. The opposite source of data will be populated based upon that source of info. E.g. if the MPTT fields are corrupt or empty, with the $mode 'parent' the values of the parent_id field will be used to populate the left and right fields. The missingParentAction parameter only applies to "parent" mode and determines what to do if the parent field contains an id that is not present.

Available $mode options:

• 'parent' - use the existing parent_id's to update the lft and rght fields

• 'tree' - use the existing lft and rght fields to update parent_id

Available missingParentActions options when using mode='parent':

• null - do nothing and carry on

• 'return' - do nothing and return

• 'delete' - delete the node

• int - set the parent_id to this id

// Rebuild all the left and right fields based on the parent_id
$this->Category->recover();
// or
$this->Category->recover('parent');

// Rebuild all the parent_id's based on the lft and rght fields
$this->Category->recover('tree');

Reorder¶

reorder(&$model, $options = array())

Reorders the nodes (and child nodes) of the tree according to the field and direction specified in the parameters. This method does not change the parent of any node.

Reordering affects all nodes in the tree by default, however the following options can affect the process:

• 'id' - only reorder nodes below this node.

• 'field' - field to use for sorting, default is the displayField for the model.

• 'order' - 'ASC' for ascending, 'DESC' for descending sort.

• 'verify' - whether or not to verify the tree prior to resorting.

$options is used to pass all extra parameters, and has the following possible keys by default, all of which are optional:

array(
    'id' => null,
    'field' => $model->displayField,
    'order' => 'ASC',
    'verify' => true
)

Verify¶

verify(&$model)

Returns true if the tree is valid otherwise an array of errors, with fields for type, incorrect index and message.

Each record in the output array is an array of the form (type, id, message)

• type is either 'index' or 'node'

• 'id' is the id of the erroneous node.

• 'message' depends on the error

$this->Categories->verify();

Example output:

Array
(
    [0] => Array
        (
            [0] => node
            [1] => 3
            [2] => left and right values identical
        )
    [1] => Array
        (
            [0] => node
            [1] => 2
            [2] => The parent node 999 doesn't exist
        )
    [10] => Array
        (
            [0] => index
            [1] => 123
            [2] => missing
        )
    [99] => Array
        (
            [0] => node
            [1] => 163
            [2] => left greater than right
        )

)