Need help with eloquent-tree?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

AdrianSkierniewski
129 Stars 20 Forks MIT License 68 Commits 2 Opened issues

Description

Eloquent Tree is a tree model for Laravel Eloquent ORM.

Services available

!
?

Need anything else?

Contributors list

eloquent-tree Latest Stable Version Total Downloads Build Status

Eloquent Tree is a tree model for Laravel Eloquent ORM.

Table of Contents

Features

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

Installation

Version 1.0 is not compatible with 0.*

Version 2.0 - Laravel 5 support

Version 2.1 - Laravel 5.1 support

Version 3.0 - Laravel 5.3 support

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

json
"require": {
    "laravel/framework": "5.3.*",
    "gzero/eloquent-tree": "v3.0.*"
},
"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

php
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

$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

php
$leaf->findRoot();

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

php
$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
php
$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

php
$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

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

Getting leaf nodes

Tree::getLeaves();

Map from array

Three new roots, first with descendants

php
 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

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

    Events

    All tree models have additional events: * updatingParent * updatedParent * updatedDescendants

    You can use them for example to update additional tables

    Support

    If you enjoy my work, please consider making a small donation, so I can continue to maintain and create new software to help other users.

    PayPal

    We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.