Hierarchical or tree database implementation using path enumeration model
laraditz/laravel-tree is a Laravel package for hierarchical or tree database implementation using path enumeration model.
It currently has 1 GitHub stars and 122 downloads on Packagist (latest version 0.0.3).
Install it with composer require laraditz/laravel-tree.
Discover more Laravel packages by laraditz
or browse all Laravel packages to compare alternatives.
Last updated
Hierarchical or tree database implementation using path enumeration model.
You can install the package via composer:
composer require laraditz/laravel-tree
Add the tree columns to your table by adding addLaravelTreeColumns to your database migration file.
For example, we add the tree columns to the trees table as shown below.
Schema::create('trees', function (Blueprint $table) {
...
$table->addLaravelTreeColumns();
...
});
Then, add the HasTreeNode to the model.
use Laraditz\LaravelTree\HasTreeNode;
class Tree extends Model
{
use HasTreeNode;
}
Create node as root.
Tree::create([
'user_id' => 1
])->asRoot()
Create node as child.
// $tree is the parent object
Tree::create([
'user_id' => 2
])->asChildOf($tree);
// or
$tree->appendChild([
'user_id' => 2
]);
Below are all relationships under the HasTreeNode.
| Relationship name | Description
|---------------------------|---------------------------------|
| parent() | Parent of current node. (1-1)
| child() | Children of current node. (1-N)
Below are all attributes under the HasTreeNode.
| Attribute name | Description
|---------------------------|---------------------------------|
| child_count | Get number of children.
| direct_child_count | Get number of cirect children.
| has_child | Check if children exists.
Below are all methods under the HasTreeNode.
| Method name | Description
|---------------------------|---------------------------------|
| getChildCount() | Count number of children.
| getChildCount(int $level) | Count number of children based on level.
| getDirectChildCount() | Count number of cirect children.
| getParentIds() | Get parent ids from bottom-up.
| moveNode($node) | Move node to new parent $node.
| isChildOf($node) | Check is current node is child or distinct child of $node.
| isSameTree($node) | Check is current node is from the same tree as $node.
| isRootNode() | Check if current node is a root node.
| isSameNode($node) | Compare two nodes is the same or not.
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
