uccello/eloquent-tree

Eloquent Tree transforms a model into tree model for Laravel Eloquent ORM.

1.2.0 2024-08-25 15:30 UTC

Requires

• laravel/framework: ^8.0|^9.0|^10.0|^11.0

MIT

• Jonathan SARDO

README

Eloquent Tree transforms a model into tree model for Laravel Eloquent ORM.

This project is based on the original project made by Adrian Skierniewski. It was changed to be able to use this functionnality thanks to the IsTree trait, instead of extending the Tree model. It is useful if you want your model extends another class.

Table of Contents

• Features
• Installation
• Migration
• Example usage
• Events
• Support

##Features

• Creating root, children and sibling nodes
• Getting children
• Getting descendants
• Getting ancestor
• Moving sub-tree
• Building tree on PHP side

Installation

For Laravel >= 5.3

Begin by installing this package through Composer. Edit your project's composer.json file to require uccello/eloquent-tree.

"require": {
    "uccello/eloquent-tree": "1.*"
},
"minimum-stability" : "stable"

Next, update Composer from the Terminal:

composer update

That's all now you can extend \Gzero\EloquentTree\Model\Tree in your project

Migration

Simply migration with all required columns that you could extend by adding new fields

Schema::create(
    'trees',
    function (Blueprint $table) {
        $table->increments('id');
        $table->string('path', 255)->nullable();
        $table->integer('parent_id')->unsigned()->nullable();
        $table->integer('level')->default(0);
        $table->timestamps();
        $table->index(array('path', 'parent_id', 'level'));
        $table->foreign('parent_id')->references('id')->on('contents')->onDelete('CASCADE');
    }
);

Example usage

• Inserting and Updating new nodes
• Getting tree nodes
• Finding Leaf nodes
• Map from array
• Rendering tree

Inserting and updating new nodes

$root = new Tree(); // New root
$root->setAsRoot();
$child = with(new Tree())->setChildOf($root); // New child
$sibling = new Tree();
$sibling->setSiblingOf($child); // New sibling

Getting tree nodes

Leaf - returning root node

$leaf->findRoot();

Children - returning flat collection of children. You can use Eloquent query builder.

$collection = $root->children()->get();
$collection2 = $root->children()->where('url', '=', 'slug')->get();

Ancestors - returning flat collection of ancestors, first is root, last is current node. You can use Eloquent query builder. Of course there are no guarantees that the structure of the tree would be complete if you do the query with additional where

$collection = $node->findAncestors()->get();
$collection2 = $node->findAncestors()->where('url', '=', 'slug')->get();

Descendants - returning flat collection of descendants, first is current node, last is leafs. You can use Eloquent query builder. Of course there are no guarantees that the structure of the tree would be complete if you do the query with additional where

$collection = $node->findDescendants()->get();
$collection2 = $node->findDescendants()->where('url', '=', 'slug')->get();

Building tree structure on PHP side - if some nodes will be missing, these branches will not be built

$treeRoot = $root->buildTree($root->findDescendants()->get())

Getting leaf nodes

Tree::getLeaves();

Map from array

Three new roots, first with descendants

 Tree::mapArray(
            array(
                array(
                    'children' => array(
                        array(
                            'children' => array(
                                array(
                                    'children' => array(
                                        array(
                                            'children' => array()
                                        ),
                                        array(
                                            'children' => array()
                                        )
                                    )
                                ),
                                array(
                                    'children' => array()
                                )
                            )
                        ),
                        array(
                            'children' => array()
                        )
                    )
                ),
                array(
                    'children' => array()
                ),
                array(
                    'children' => array()
                )
            )
 );

Rendering tree

You can render tree built by the function buildTree

 $html = $root->render(
        'ul',
        function ($node) {
            return '<li>' . $node->title . '{sub-tree}</li>';
        },
        TRUE
        );
 echo $html;

Events

All tree models have additional events:

• updatingParent
• updatedParent
• updatedDescendants

You can use them for example to update additional tables

Credits

• Adrian Skierniewski

• Uccello Labs

• Jonathan SARDO

• All Contributors

License

The MIT License (MIT). Please see License File for more information.