2017 © Pedro Peláez
 

yii2-extension yii2-nested-sets

Nested Sets Behavior for Yii2

image

paulzi/yii2-nested-sets

Nested Sets Behavior for Yii2

  • Monday, July 23, 2018
  • by PaulZi
  • Repository
  • 9 Watchers
  • 51 Stars
  • 18,135 Installations
  • PHP
  • 13 Dependents
  • 0 Suggesters
  • 18 Forks
  • 1 Open issues
  • 10 Versions
  • 21 % Grown

The README.md

Yii2 Nested Sets Behavior

Implementation of nested sets algorithm for storing the trees in DB tables., (*1)

Packagist Version Code Coverage Build Status Total Downloads, (*2)

Install

Install via Composer:, (*3)

composer require paulzi/yii2-nested-sets

or add, (*4)

"paulzi/yii2-nested-sets" : "^1.0"

to the require section of your composer.json file., (*5)

Migrations example

Warning! depth attribute can not be unsigned!, (*6)

Single tree migration:, (*7)

class m150722_150000_single_tree extends Migration
{
    public function up()
    {
        $tableOptions = null;
        if ($this->db->driverName === 'mysql') {
            // http://stackoverflow.com/questions/766809/whats-the-difference-between-utf8-general-ci-and-utf8-unicode-ci
            $tableOptions = 'CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE=InnoDB';
        }
        $this->createTable('{{%single_tree}}', [
            'id'    => Schema::TYPE_PK,
            'lft'   => Schema::TYPE_INTEGER . ' NOT NULL',
            'rgt'   => Schema::TYPE_INTEGER . ' NOT NULL',
            'depth' => Schema::TYPE_INTEGER . ' NOT NULL', // not unsigned!
            'name'  => Schema::TYPE_STRING . ' NOT NULL', // example field
        ], $tableOptions);
        $this->createIndex('lft', '{{%single_tree}}', ['lft', 'rgt']);
        $this->createIndex('rgt', '{{%single_tree}}', ['rgt']);
    }
}

Multiple tree migration:, (*8)

class m150722_150100_multiple_tree extends Migration
{
    public function up()
    {
        $tableOptions = null;
        if ($this->db->driverName === 'mysql') {
            // http://stackoverflow.com/questions/766809/whats-the-difference-between-utf8-general-ci-and-utf8-unicode-ci
            $tableOptions = 'CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE=InnoDB';
        }
        $this->createTable('{{%multiple_tree}}', [
            'id'    => Schema::TYPE_PK,
            'tree'  => Schema::TYPE_INTEGER . ' NULL',
            'lft'   => Schema::TYPE_INTEGER . ' NOT NULL',
            'rgt'   => Schema::TYPE_INTEGER . ' NOT NULL',
            'depth' => Schema::TYPE_INTEGER . ' NOT NULL', // not unsigned!
            'name'  => Schema::TYPE_STRING . ' NOT NULL', // example field
        ], $tableOptions);
        $this->createIndex('lft', '{{%multiple_tree}}', ['tree', 'lft', 'rgt']);
        $this->createIndex('rgt', '{{%multiple_tree}}', ['tree', 'rgt']);
    }
}

Configuring

use paulzi\nestedsets\NestedSetsBehavior;

/**
 * @property integer $id
 * @property integer $lft
 * @property integer $rgt
 * @property integer $depth
 *
 * @mixin NestedSetsBehavior
 */

class Sample extends \yii\db\ActiveRecord
{
    public function behaviors() {
        return [
            [
                'class' => NestedSetsBehavior::class,
                // 'treeAttribute' => 'tree',
            ],
        ];
    }

    public function transactions()
    {
        return [
            self::SCENARIO_DEFAULT => self::OP_ALL,
        ];
    }
}

Optional you can setup Query for finding roots:, (*9)

class Sample extends \yii\db\ActiveRecord
{
    public static function find()
    {
        return new SampleQuery(get_called_class());
    }
}

Query class:, (*10)

use paulzi\nestedsets\NestedSetsQueryTrait;

class SampleQuery extends \yii\db\ActiveQuery
{
    use NestedSetsQueryTrait;
}

Options

  • $treeAttribute = null - setup tree attribute for multiple tree in table schema.
  • $leftAttribute = 'lft' - left attribute in table schema.
  • $rightAttribute = 'rgt' - right attribute in table schema.
  • $depthAttribute = 'depth' - depth attribute in table schema (note: it must be signed int).

Usage

Selection

Getting the root nodes, (*11)

If you connect NestedSetsQueryTrait, you can get all the root nodes:, (*12)

$roots = Sample::find()->roots()->all();

Getting ancestors of a node, (*13)

To get ancestors of a node:, (*14)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$parents = $node11->parents; // via relation
$parents = $node11->getParents()->all(); // via query
$parents = $node11->getParents(2)->all(); // get 2 levels of ancestors

To get parent of a node:, (*15)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$parent = $node11->parent; // via relation
$parent = $node11->getParent()->one(); // via query

To get root of a node:, (*16)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$root = $node11->root; // via relation
$root = $node11->getRoot()->one(); // via query

Getting descendants of a node, (*17)

To get all the descendants of a node:, (*18)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$descendants = $node11->descendants; // via relation
$descendants = $node11->getDescendants()->all(); // via query
$descendants = $node11->getDescendants(2, true)->all(); // get 2 levels of descendants and self node
$descendants = $node11->getDescendants(3, false, true)->all(); // get 3 levels of descendants in back order

To populate children relations for self and descendants of a node:, (*19)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$tree = $node11->populateTree(); // populate all levels
$tree = $node11->populateTree(2); // populate 2 levels of descendants

To get the children of a node:, (*20)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$children = $node11->children; // via relation
$children = $node11->getChildren()->all(); // via query

Getting the leaves nodes, (*21)

To get all the leaves of a node:, (*22)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$leaves = $node11->leaves; // via relation
$leaves = $node11->getLeaves(2)->all(); // get 2 levels of leaves via query

Getting the neighbors nodes, (*23)

To get the next node:, (*24)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$next = $node11->next; // via relation
$next = $node11->getNext()->one(); // via query

To get the previous node:, (*25)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$prev = $node11->prev; // via relation
$prev = $node11->getPrev()->one(); // via query

Some checks

$node1 = Sample::findOne(['name' => 'node 1']);
$node11 = Sample::findOne(['name' => 'node 1.1']);
$node11->isRoot() - return true, if node is root
$node11->isLeaf() - return true, if node is leaf
$node11->isChildOf($node1) - return true, if node11 is child of $node1

Modifications

To make a root node:, (*26)

$node11 = new Sample();
$node11->name = 'node 1.1';
$node11->makeRoot()->save();

Note: if you allow multiple trees and attribute tree is not set, it automatically takes the primary key value., (*27)

To prepend a node as the first child of another node:, (*28)

$node1 = Sample::findOne(['name' => 'node 1']);
$node11 = new Sample();
$node11->name = 'node 1.1';
$node11->prependTo($node1)->save(); // inserting new node

To append a node as the last child of another node:, (*29)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$node12 = Sample::findOne(['name' => 'node 1.2']);
$node12->appendTo($node11)->save(); // move existing node

To insert a node before another node:, (*30)

$node13 = Sample::findOne(['name' => 'node 1.3']);
$node12 = new Sample();
$node12->name = 'node 1.2';
$node12->insertBefore($node13)->save(); // inserting new node

To insert a node after another node:, (*31)

$node13 = Sample::findOne(['name' => 'node 1.3']);
$node14 = Sample::findOne(['name' => 'node 1.4']);
$node14->insertAfter($node13)->save(); // move existing node

To delete a node with descendants:, (*32)

$node11 = Sample::findOne(['name' => 'node 1.1']);
$node11->delete(); // delete node, children come up to the parent
$node11->deleteWithChildren(); // delete node and all descendants

The Versions

23/07 2018

dev-master

9999999-dev

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

21/07 2018

v1.0.8

1.0.8.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

02/04 2018

v1.0.7

1.0.7.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

14/10 2016

v1.0.6

1.0.6.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

13/10 2016

v1.0.5

1.0.5.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

21/07 2016

v1.0.4

1.0.4.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

15/01 2016

v1.0.3

1.0.3.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

11/12 2015

v1.0.2

1.0.2.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

18/09 2015

v1.0.1

1.0.1.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets

23/07 2015

v1.0.0

1.0.0.0

Nested Sets Behavior for Yii2

  Sources   Download

MIT

The Requires

 

by Alexander Kochetov
by Avatar PaulZi

yii2 nested sets