sieulog/yii2-nested-sets

The nested sets behavior for the Yii framework

Nested Sets Behavior for Yii 2

, _(*1)

A modern nested sets behavior for the Yii framework utilizing the Modified Preorder Tree Traversal algorithm., _(*2)

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

$ composer require creocoder/yii2-nested-sets

or add, _(*5)

"creocoder/yii2-nested-sets": "0.9.*"

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

Migrations

Run the following command, _(*7)

$ yii migrate/create create_menu_table

Open the /path/to/migrations/m_xxxxxx_xxxxxx_create_menu_table.php file, inside the up() method add the following, _(*8)

$this->createTable('{{%menu}}', [
    'id' => Schema::TYPE_PK,
    // 'tree' => Schema::TYPE_INTEGER,
    'lft' => Schema::TYPE_INTEGER . ' NOT NULL',
    'rgt' => Schema::TYPE_INTEGER . ' NOT NULL',
    'depth' => Schema::TYPE_INTEGER . ' NOT NULL',
    'name' => Schema::TYPE_STRING . ' NOT NULL',
]);

To use multiple tree mode uncomment tree field., _(*9)

Configuring

Configure model as follows, _(*10)

use creocoder\nestedsets\NestedSetsBehavior;

class Menu extends \yii\db\ActiveRecord
{
    public function behaviors() {
        return [
            'tree' => [
                'class' => NestedSetsBehavior::className(),
                // 'treeAttribute' => 'tree',
                // 'leftAttribute' => 'lft',
                // 'rightAttribute' => 'rgt',
                // 'depthAttribute' => 'depth',
            ],
        ];
    }

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

    public static function find()
    {
        return new MenuQuery(get_called_class());
    }
}

To use multiple tree mode uncomment treeAttribute array key inside behaviors() method., _(*11)

Configure query class as follows, _(*12)

use creocoder\nestedsets\NestedSetsQueryBehavior;

class MenuQuery extends \yii\db\ActiveQuery
{
    public function behaviors() {
        return [
            NestedSetsQueryBehavior::className(),
        ];
    }
}

Usage

Making a root node

To make a root node, _(*13)

$countries = new Menu(['name' => 'Countries']);
$countries->makeRoot();

The tree will look like this, _(*14)

- Countries

Prepending a node as the first child of another node

To prepend a node as the first child of another node, _(*15)

$russia = new Menu(['name' => 'Russia']);
$russia->prependTo($countries);

The tree will look like this, _(*16)

- Countries
    - Russia

Appending a node as the last child of another node

To append a node as the last child of another node, _(*17)

$australia = new Menu(['name' => 'Australia']);
$australia->appendTo($countries);

The tree will look like this, _(*18)

- Countries
    - Russia
    - Australia

Inserting a node before another node

To insert a node before another node, _(*19)

$newZeeland = new Menu(['name' => 'New Zeeland']);
$newZeeland->insertBefore($australia);

The tree will look like this, _(*20)

- Countries
    - Russia
    - New Zeeland
    - Australia

Inserting a node after another node

To insert a node after another node, _(*21)

$unitedStates = new Menu(['name' => 'United States']);
$unitedStates->insertAfter($australia);

The tree will look like this, _(*22)

- Countries
    - Russia
    - New Zeeland
    - Australia
    - United States

Getting the root nodes

To get all the root nodes, _(*23)

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

Getting the leaves nodes

To get all the leaves nodes, _(*24)

$leaves = Menu::find()->leaves()->all();

To get all the leaves of a node, _(*25)

$countries = Menu::findOne(['name' => 'Countries']);
$leaves = $countries->leaves()->all();

Getting children of a node

To get all the children of a node, _(*26)

$countries = Menu::findOne(['name' => 'Countries']);
$children = $countries->children()->all();

To get the first level children of a node, _(*27)

$countries = Menu::findOne(['name' => 'Countries']);
$children = $countries->children(1)->all();

Getting parents of a node

To get all the parents of a node, _(*28)

$countries = Menu::findOne(['name' => 'Countries']);
$parents = $countries->parents()->all();

To get the first parent of a node, _(*29)

$countries = Menu::findOne(['name' => 'Countries']);
$parent = $countries->parents(1)->one();

Donating

Support this project and others by creocoder via gratipay., _(*30)

, _(*31)