mirror of
https://github.com/Oreolek/yii2-nested-sets.git
synced 2024-07-03 06:55:00 +03:00
adding more explanation about how the fields have to be set up
This commit is contained in:
parent
3a662b2bd0
commit
622ae6ab00
25
README.md
25
README.md
|
@ -69,9 +69,11 @@ class TreeQuery extends \yii\db\ActiveQuery
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The model has to have several fields:
|
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 have to set up the behavior in this way.
|
|
||||||
The example assumes that you want to change the name to `left`.
|
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
|
```php
|
||||||
public function behaviors() {
|
public function behaviors() {
|
||||||
return [
|
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,
|
2. `rgt`, type integer. To change the name of the field make the same setting as for lft,
|
||||||
but use the attribute `rightAttribute`
|
but use the attribute `rightAttribute`
|
||||||
|
|
||||||
3. `depth`, type integer. To change the name of the field make the same setting as for lft,
|
3. `depth`, type integer. To change the name of the field make the same setting as for lft,
|
||||||
but use the attribute `depthAttribute`
|
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
|
### 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
|
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`
|
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
|
## Usage
|
||||||
|
|
||||||
### Quick Example
|
### Quick Example
|
||||||
|
|
Loading…
Reference in a new issue