Implementation of materialized path algorithm for storing the trees in DB tables.
Install via Composer:
composer require paulzi/yii2-materialized-pathor add
"paulzi/yii2-materialized-path" : "^1.0"to the require section of your composer.json file.
Sample migrations are in the folder sample-migrations:
m150722_150000_single_tree.php- for single tree tables;m150722_150100_multiple_tree.php- for multiple tree tables.
use paulzi\materializedpath\MaterializedPathBehavior;
class Sample extends \yii\db\ActiveRecord
{
public function behaviors() {
return [
[
'class' => MaterializedPathBehavior::className(),
// 'treeAttribute' => 'tree',
],
];
}
public function transactions()
{
return [
self::SCENARIO_DEFAULT => self::OP_ALL,
];
}
}Optional you can setup Query for finding roots:
class Sample extends \yii\db\ActiveRecord
{
public static function find()
{
return new SampleQuery(get_called_class());
}
}Query class:
use paulzi\,aterializedpath\MaterializedPathQueryTrait;
class SampleQuery extends \yii\db\ActiveQuery
{
use MaterializedPathQueryTrait;
}$pathAttribute = 'path'- setup path attribute in table schema.$depthAttribute = 'depth'- setup depth attribute in table schema.$sortAttribute = 'sort'- setup sort attribute in table schema.$itemAttribute = null- setup item attribute in table schema for get path path, if the value is not set - using the primary key.$treeAttribute = null- setup tree attribute for multiple tree, when item attribute is not primary key.$delimiter = '/'- delimiter of path items.$step = 100- gap size between elements.
Getting the root nodes
If you connect NestedSetsQueryTrait, you can get all the root nodes:
$roots = Sample::find()->roots()->all();Getting ancestors of a node
To get ancestors of a node:
$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 ancestorsTo get parent of a node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$parent = $node11->parent; // via relation
$parent = $node11->getParent()->one(); // via queryTo get root of a node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$root = $node11->root; // via relation
$root = $node11->getRoot()->one(); // via queryGetting descendants of a node
To get all the descendants of a node:
$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 nodeTo get the children of a node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$children = $node11->children; // via relation
$children = $node11->getChildren()->all(); // via queryGetting the leaves nodes
To get all the leaves of a node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$leaves = $node11->leaves; // via relation
$leaves = $node11->getLeaves(2)->all(); // get 2 levels of leaves via queryGetting the neighbors nodes
To get the next node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$next = $node11->next; // via relation
$next = $node11->getNext()->one(); // via queryTo get the previous node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$prev = $node11->prev; // via relation
$prev = $node11->getPrev()->one(); // via query$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 $node1To make a root node:
$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.
To prepend a node as the first child of another node:
$node1 = Sample::findOne(['name' => 'node 1']);
$node11 = new Sample();
$node11->name = 'node 1.1';
$node11->prependTo($node1)->save(); // inserting new nodeTo append a node as the last child of another node:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$node12 = Sample::findOne(['name' => 'node 1.2']);
$node12->appendTo($node11)->save(); // move existing nodeTo insert a node before another node:
$node13 = Sample::findOne(['name' => 'node 1.3']);
$node12 = new Sample();
$node12->name = 'node 1.2';
$node12->insertBefore($node13)->save(); // inserting new nodeTo insert a node after another node:
$node13 = Sample::findOne(['name' => 'node 1.3']);
$node14 = Sample::findOne(['name' => 'node 1.4']);
$node14->insertAfter($node13)->save(); // move existing nodeTo delete a node with descendants:
$node11 = Sample::findOne(['name' => 'node 1.1']);
$node11->delete(); // delete node, children come up to the parent
$node11->deleteWithChildren(); // delete node and all descendants