oreolek/yii2-nested-sets
1
0
Fork 0
mirror of https://github.com/Oreolek/yii2-nested-sets.git synced 2024-06-29 04:55:00 +03:00
Code Issues Releases Wiki Activity

adding more explanation about how the fields have to be set up

Browse source
This commit is contained in:
Mihai Petrescu 2015-01-07 11:17:39 +11:00
parent 3a662b2bd0
commit 622ae6ab00
1 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -69,9 +69,11 @@ class TreeQuery extends \yii\db\ActiveQuery
}
```
The model has to have several fields:
1. `lft`, type integer, if you do not want to use this default name you have to set up the behavior in this way.
The example assumes that you want to change the name to `left`.
The model has to have several fields. The fields that need to be set up are:
1. `lft`, type integer. If you do not want to use this default name you can change it by setting up
the `rightAttribute` attribute. The example assumes that you want to change the name to `left`.
```php
public function behaviors() {
return [
@ -82,11 +84,26 @@ public function behaviors() {
];
}
```
2. `rgt`, type integer. To change the name of the field make the same setting as for lft,
but use the attribute `rightAttribute`
3. `depth`, type integer. To change the name of the field make the same setting as for lft,
but use the attribute `depthAttribute`
These fields should be set up in the rules section of the model like this.
```php
public function rules()
{
return [
............
[['lft', 'rgt', 'depth'], 'integer'],
............
];
}
```
### Multiple Tree mode
If you use a tree with multiple roots, besides the fields set up for the single tree, you have to set up an additional
field. The type of the new field is integer. The following example is for a tree attribute field named `root`
@ -101,6 +118,8 @@ public function behaviors() {
}
```
Add this field to the rules function in the same way as the ones for the single tree.
## Usage
### Quick Example