CakePHP4 同一モデル内で階層データの取得

Question

前提・実現したいこと

CakePHP4.0で、同一モデル内で階層データを取得したいのですが、どうしてもうまくいきません。

https://book.cakephp.org/3/ja/orm/behaviors/tree.html
を参照しましたが、理解が追いつきませんでした。

該当のソースコード

SamplesController.php

public function index()
{
    $this->paginate = [
        'contain' => ['ParentSamples'],
        'order' => ['lft' => 'asc'],
        'limit' => 100,
    ];
    $samples = $this->paginate($this->Samples);
    $this->set(compact('samples'));
}

MySQL内では次のようにフィールドを持っています。
id, parent_id, lft, rhgt, level, name, created, modified

parent_idがnullでない場合は子データを親データにぶら下げて取得したいのですが、どのようにしたらよいでしょうか。何卒ご教示ください。

TreeビヘイビアによるmoveUP/moveDownは動作しています。

###2020/06/04 9:25追記

belongsToではなくhaManyに変更することで、それっぽいデータが取れました。
これでいいのかな。
第2階層までしか取得できなかった。(9:45追記)

SamplesTable.php

//        $this->belongsTo('ParentSamples', [
        $this->hasMany('ParentSamples', [
            'className' => 'Samples',
            'foreignKey' => 'parent_id',
        ]);

Comments

[nojimage]

> ”parent_idがnullでない場合は子データを親データにぶら下げて取得したい”
parent_idに値があるのは子データなので、親データに子データをぶら下げて取得したいということでいいですか？

[TamagawaBam]

コメントありがとうございます。ご認識の通りです。

Answer 1

第一階層のエンティティを取得するクエリにページネーションを適用し、取得したエンティティに対して、子エンティティを付与するやり方が考えられます。

取得したエンティティに対してデータを加工するには、formatResults メソッドを利用すると良いでしょう。

     $query = $this->Samples
        ->find()
        ->where(['parent_id' => null]) // 第1階層に限定して取得
        ->formatResults(function (CollectionInterface $resultSet) {
        	// 取得した1階層のレコードに対して子エンティティを取得してスレッド形式で付与する
            return $resultSet->map(function (EntityInterface $entity) {
                $entity->children = $this->Samples
                    ->find('children', ['for' => $entity->id])
                    ->find('threaded')
                    ->all();

                return $entity;
            });
        });

    $this->paginate($query);

ただし、取得した件数分、子エンティティ取得のためのクエリを発行するので、一度に大量のエンティティを取得する場合はパフォーマンスに注意してください。

Comments

[TamagawaBam]

明快な回答をありがとうございます。勉強になりました。

> ただし、取得した件数分、子エンティティ取得のためのクエリを発行するので、一度に大量のエンティティを取得する場合はパフォーマンスに注意してください。

質問後もあれこれと思案しましたが、findを連発する方法しか思いつかず、ご指摘の件が気になっていました。

結局のところ何がしたかったというと、n階層のツリー構造データを、インデントに加えて罫線（｜、├、└）を用いてきれいに表示したかったのです。

現在は、階層構造での取得を諦め、ページネーションで全データ取得し、さらにnの値、末っ子判別用配列と親判別用配列をSet、あとはView側でなんとかする方法に収まりました。