PHP Класс skeeks\cms\models\Tree

Наследование: extends Core, use trait skeeks\cms\models\behaviors\traits\HasRelatedPropertiesTrait
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
afterDeleteTree ( Event $event ) После удаления нужно родителя пересчитать
afterUpdateTree ( yii\db\AfterSaveEvent $event ) Изменился код
attributeLabels ( )
beforeDeleteTree ( Event $event ) Если есть дети для начала нужно удалить их всех
beforeSaveTree ( $event ) Проверки и дополнения перед сохранением раздела
behaviors ( ) Шаг приоритета
findRoots ( ) : ActiveQuery Корневые разделы дерева.
generateCode ( ) Автоматическая генерация code по названию
generateName ( ) Автоматическая генерация названия раздела
getAbsoluteUrl ( ) : string
getChildren ( ) : ActiveQuery
getCmsContentElementTrees ( ) : ActiveQuery
getCmsContentElements ( ) : ActiveQuery
getCmsSiteRelation ( ) : ActiveQuery
getCmsTreeFiles ( ) : ActiveQuery
getCmsTreeImages ( ) : ActiveQuery
getCmsTreeProperties ( ) : ActiveQuery
getDescendants ( ) : ActiveQuery
getFiles ( ) : ActiveQuery
getFullImage ( ) : ActiveQuery
getImage ( ) : ActiveQuery
getImages ( ) : ActiveQuery
getNext ( ) : ActiveQuery
getParent ( ) : ActiveQuery
getParents ( integer | null $depth = null ) : ActiveQuery
getParentsIds ( null $depth = null ) : array
getPrev ( ) : ActiveQuery
getRedirectTree ( ) : ActiveQuery
getRelatedProperties ( ) : array | ActiveRecord[]
getRoot ( ) : ActiveQuery To get root of a node:
getSite ( ) : CmsSite
getTreeType ( ) : ActiveQuery
getUrl ( $scheme = false ) : string
init ( )
isRoot ( ) : boolean
processAddNode ( Tree $target ) Процесс вставки ноды одна в другую.
processCreateNode ( Tree $target ) : Tree Создание дочерней ноды
processNormalize ( ) Обновление всего дерева ниже, и самого элемента.
rules ( )
setAttributesForFutureParent ( Tree $parent ) Установка атрибутов если родителем этой ноды будет новый, читаем родителя, и обновляем необходимые данные у себя
tableName ( )

Защищенные методы

Метод Описание
isValidCode ( ) : boolean

Описание методов

afterDeleteTree() публичный Метод

После удаления нужно родителя пересчитать
public afterDeleteTree ( Event $event )
$event yii\base\Event

afterUpdateTree() публичный Метод

Изменился код
public afterUpdateTree ( yii\db\AfterSaveEvent $event )
$event yii\db\AfterSaveEvent

attributeLabels() публичный Метод

public attributeLabels ( )

beforeDeleteTree() публичный Метод

Если есть дети для начала нужно удалить их всех
public beforeDeleteTree ( Event $event )
$event yii\base\Event

beforeSaveTree() публичный Метод

Проверки и дополнения перед сохранением раздела
public beforeSaveTree ( $event )
$event

behaviors() публичный Метод

Шаг приоритета
public behaviors ( )

findRoots() публичный статический Метод

Корневые разделы дерева.
public static findRoots ( ) : ActiveQuery
Результат yii\db\ActiveQuery

generateCode() публичный Метод

Автоматическая генерация code по названию
public generateCode ( )

generateName() публичный Метод

Автоматическая генерация названия раздела
public generateName ( )

getAbsoluteUrl() публичный Метод

public getAbsoluteUrl ( ) : string
Результат string

getChildren() публичный Метод

public getChildren ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getCmsContentElementTrees() публичный Метод

public getCmsContentElementTrees ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getCmsContentElements() публичный Метод

public getCmsContentElements ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getCmsSiteRelation() публичный Метод

public getCmsSiteRelation ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getCmsTreeFiles() публичный Метод

public getCmsTreeFiles ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getCmsTreeImages() публичный Метод

public getCmsTreeImages ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getCmsTreeProperties() публичный Метод

public getCmsTreeProperties ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getDescendants() публичный Метод

public getDescendants ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getFiles() публичный Метод

public getFiles ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getFullImage() публичный Метод

public getFullImage ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getImage() публичный Метод

public getImage ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getImages() публичный Метод

public getImages ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getNext() публичный Метод

public getNext ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getParent() публичный Метод

public getParent ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getParents() публичный Метод

public getParents ( integer | null $depth = null ) : ActiveQuery
$depth integer | null
Результат yii\db\ActiveQuery

getParentsIds() публичный Метод

public getParentsIds ( null $depth = null ) : array
$depth null
Результат array

getPrev() публичный Метод

public getPrev ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getRedirectTree() публичный Метод

public getRedirectTree ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getRelatedProperties() публичный Метод

public getRelatedProperties ( ) : array | ActiveRecord[]
Результат array | yii\db\ActiveRecord[]

getRoot() публичный Метод

To get root of a node:
public getRoot ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getSite() публичный Метод

public getSite ( ) : CmsSite
Результат CmsSite

getTreeType() публичный Метод

public getTreeType ( ) : ActiveQuery
Результат yii\db\ActiveQuery

getUrl() публичный Метод

public getUrl ( $scheme = false ) : string
Результат string

init() публичный Метод

public init ( )

isRoot() публичный Метод

public isRoot ( ) : boolean
Результат boolean

isValidCode() защищенный Метод

protected isValidCode ( ) : boolean
Результат boolean

processAddNode() публичный Метод

Можно вставлять как уже сохраненную модель с дочерними элементами, так и еще не сохраненную.
public processAddNode ( Tree $target )
$target Tree

processCreateNode() публичный Метод

Создание дочерней ноды
public processCreateNode ( Tree $target ) : Tree
$target Tree
Результат Tree

processNormalize() публичный Метод

Если найти всех рутов дерева и запустить этот метод, то дерево починиться в случае поломки правильно переустановятся все dir, pids и т.д.
public processNormalize ( )

rules() публичный Метод

public rules ( )

setAttributesForFutureParent() публичный Метод

Установка атрибутов если родителем этой ноды будет новый, читаем родителя, и обновляем необходимые данные у себя
public setAttributesForFutureParent ( Tree $parent )
$parent Tree

tableName() публичный статический Метод

public static tableName ( )