gregoryduckworth / nestablecollection
A Laravel Package that extends Collection to handle unlimited nested items following adjacency list model.
README
A Laravel/Lumen Package that extends Collection to handle unlimited nested items following adjacency list model.
Installation
Run composer require typicms/nestablecollection
Usage
The model must have a parent_id attributes :
protected $fillable = array( 'parent_id', // … }
and must use the following trait:
use TypiCMS\NestableTrait;
Now each time you get a collection of that model, it will be an instance of TypiCMS\NestableCollection in place of Illuminate\Database\Eloquent\Collection.
If you want a tree of models, simply call the nest method on a collection ordered by parent_id asc and pass the column on which you want the nesting to occurr :
Model::orderBy('parent_id')->get()->nest('parent_id');
Of course you will probably want a position column as well. So you will have to order first by parent_id asc and then by position asc.
Indented and flattened list
listsFlattened() method generate the tree as a flattened list with id as keys and title as values, perfect for select/option, for example :
[
'22' => 'Item 1 Title',
'10' => ' Child 1 Title',
'17' => ' Child 2 Title',
'14' => 'Item 2 Title',
]
To use it, first call the nest() method, followed by the listsFlattened() method:
Model::orderBy('parent_id')->get()->nest('parent_id')->listsFlattened();
By default it will look for a title column. You can send a custom column name as first parameter:
Model::orderBy('parent_id')->get()->nest('parent_id')->listsFlattened('name');
Four spaces are used to indent by default, to use your own use the setIndent() method, followed by the listsFlattened() method:
Model::orderBy('parent_id')->get()->nest('parent_id')->setIndent('> ')->listsFlattened();
Results:
[
'22' => 'Item 1 Title',
'10' => '> Child 1 Title',
'17' => '> Child 2 Title',
'14' => 'Item 2 Title',
]
Nesting a subtree
This package remove items that have missing ancestor, this doesn’t allow you to nest a branch of a tree.
To avoid this, you can use the noCleaning() method:
Model::orderBy('parent_id')->get()->noCleaning()->nest('parent_id');