README

一个扩展集合以处理按邻接表模型嵌套项目的Laravel/Lumen包。

安装

运行 composer require abdullahfaqeir/nestablecollection

用法

模型必须有一个 parent_id 属性

protected $fillable = [
    'parent_id',
    // …
];

并且必须使用以下特质

use TypiCMS\NestableTrait;

现在每次获取该模型的集合时，它都将是一个 TypiCMS\NestableCollection 实例，而不是 Illuminate\Database\Eloquent\Collection。

如果您想要一个按 parent_id 升序排序的模型树，只需在集合上调用 nest 方法即可

Model::orderBy('parent_id')->get()->nest();

当然，您可能还想要一个位置列。因此，您将必须首先按 parent_id 升序排序，然后按位置升序排序。

更改子集合的名称

默认情况下，子集合的名称为 items，但您可以通过调用 childrenName($name) 方法来更改它：例如，如果您想将子集合命名为 children

$collection->childrenName('children')->nest();

缩进和扁平化列表

listsFlattened() 方法生成一个以 id 为键、title 为值的扁平化列表，非常适合 select/option，例如

[
    '22' => 'Item 1 Title',
    '10' => '    Child 1 Title',
    '17' => '    Child 2 Title',
    '14' => 'Item 2 Title',
]

要使用它，首先调用 nest() 方法，然后调用 listsFlattened() 方法

Model::orderBy('parent_id')->get()->nest()->listsFlattened();

默认情况下，它将查找一个 title 列。您可以将自定义列名称作为第一个参数发送

Model::orderBy('parent_id')->get()->nest()->listsFlattened('name');

默认使用四个空格缩进，要使用自己的缩进，请使用 setIndent() 方法，然后调用 listsFlattened() 方法

Model::orderBy('parent_id')->get()->nest()->setIndent('> ')->listsFlattened();

结果

[
    '22' => 'Item 1 Title',
    '10' => '> Child 1 Title',
    '17' => '> Child 2 Title',
    '14' => 'Item 2 Title',
]

嵌套子树

此包删除具有缺失祖先的项，这不允许您嵌套树的分支。为了避免这种情况，您可以使用 noCleaning() 方法

Model::orderBy('parent_id')->get()->noCleaning()->nest();