Class TreeBehavior

Дерево поведения.

Разрешает объекту модели действовать как узловая структура дерева. Используется модифицированный обход дерева в порядке прямой обхода.

Объект

ModelBehavior

TreeBehavior

Пакет: Cake\Модель\Поведение
См.: http://ru.wikipedia.org/wiki/Обход_дерева
Ссылка: http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html
Авторское право: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Model/Behavior/TreeBehavior.php

Краткое описание свойств

$_defaults protected

array
Значения по умолчанию
$_deletedRow protected

array
Используется для сохранения состояния между вызовами обратного вызова удаления.
$errors public

array
Ошибки

Наследованные свойства

mapMethods, settings

Краткое описание методов

_getMax() protected
получить максимальное значение индекса в таблице.
_getMin() protected
получить минимальное значение индекса в таблице.
_getNode() protected
Возвращает один узел из дерева по его первичному ключу
_getOptions() protected

Удобный метод для создания параметров find() по умолчанию из $arg, когда это ассоциативный массив.
_recoverByParentId() protected
_recoverByParentId
_setChildrenLevel() protected
Установить уровень для потомков.
_setParent() protected
Устанавливает родителя данного узла
_sync() protected
Метод синхронизации таблицы.
afterDelete() public
Метод после удаления.
afterSave() public
Метод после сохранения. Вызывается после всех сохранений
beforeDelete() public
Сохраняет запись, которая должна быть удалена.
beforeFind() public
Выполняется перед операцией find()
beforeSave() public
Метод перед сохранением. Вызывается перед всеми сохранениями
childCount() public
Получить количество дочерних узлов
children() public
Получить дочерние узлы текущей модели
formatTreeList() public
Форматирует результат вызова find() в иерархический массив, используемый для HTML-выпадающих списков.
generateTreeList() public
Удобный метод для возвращения иерархического массива, используемого для HTML-выпадающих списков
getLevel() public
Возвращает уровень вложенности узла в дереве.
getParentNode() public
Получить родительский узел
getPath() public
Получить путь к данному узлу
moveDown() public
Переупорядочить узел без изменения родителя.
moveUp() public
Переупорядочить узел без изменения родителя.
recover() public
Восстановить поврежденное дерево
removeFromTree() public
Удалить текущий узел из дерева и переместить всех его потомков на один уровень вверх.
reorder() public
Метод переупорядочения.
setup() public
Инициализировать поведение дерева
verify() public
Проверить, является ли текущее дерево действительным.

Подробное описание методов

_getMax()source protected

_getMax( Model $Model , string $scope , string $right , integer $recursive -1 , boolean $created false )

получить максимальное значение индекса в таблице.

Параметры

Model $Model: Экземпляр модели.
string $scope: Условия фильтрации.
string $right: Правое значение
integer $recursive optional -1: Значение рекурсивного поиска.
boolean $created optional false: Является ли это новой записью.

Возвращаемое значение

integer

_getMin()source protected

_getMin( Model $Model , string $scope , string $left , integer $recursive -1 )

получить минимальное значение индекса в таблице.

Параметры

Model $Model: Экземпляр модели.
string $scope: Условия фильтрации.
string $left: Левое значение.
integer $recursive optional -1: Значение рекурсивного поиска.

Возвращаемое значение

integer

_getNode()source protected

_getNode( Model $Model , integer|string $id )

Возвращает один узел из дерева по его первичному ключу

Параметры

Model $Model: Модель, использующая это поведение
integer|string $id: Идентификатор записи для чтения

Возвращаемое значение

массив|логическое значение
Прочитанная запись или false

_getOptions()source protected

_getOptions( array $arg )

Удобный метод для создания параметров find() по умолчанию из $arg, когда это ассоциативный массив.

Параметры

array $arg: Массив

Возвращаемое значение

массив
Массив параметров

_recoverByParentId()source protected

_recoverByParentId( Model $Model , integer $counter 1 , integer|string|null $parentId null )

_recoverByParentId

Вспомогательная рекурсивная функция, используемая в функции recover

Параметры

Model $Model: Экземпляр модели.
integer $counter optional 1: Счетчик
integer|string|null $parentId optional null: Идентификатор родительской записи

Возвращаемое значение

integer
счётчик

_setChildrenLevel()source protected

_setChildrenLevel( Model $Model , integer|string $id )

Установить уровень для потомков.

Параметры

Model $Model: Модель, использующая это поведение.
integer|string $id: Идентификатор записи

_setParent()source protected

_setParent( Model $Model , integer|string|null $parentId null , boolean $created false )

Устанавливает родителя для заданного узла

Параметр force используется для переопределения логики «не изменять родителя на текущего родителя» в случае восстановления повреждённой таблицы или создания новых узлов. В противном случае он всегда должен быть false. На самом деле, этот метод мог бы быть приватным, так как вызов save с установленным parent_id также вызывает setParent

Параметры

Model $Model: Модель, использующая этот бихевиор
integer|string|null $parentId необязательный null: ID родительской записи
boolean $created необязательный false: True, если запись создана, иначе false.

Возвращаемое значение

boolean
true при успехе, false при неудаче

_sync()source protected

_sync( Model $Model , integer $shift , string $dir '+' , array $conditions array() , boolean $created false , string $field 'both' )

Метод синхронизации таблицы.

Обрабатывает операции синхронизации таблицы, учитывая область действия поведения.

Параметры

Model $Model: Экземпляр модели.
integer $shift: Смещение.
string $dir необязательный '+': Направление.
array $conditions необязательный array(): Условие.
boolean $created необязательный false: Является ли это новой записью.
string $field необязательный 'both': Тип поля.

afterDelete()source public

afterDelete( Model $Model )

Метод после удаления.

Удалить текущий узел и всех потомков с помощью метода deleteAll и синхронизировать таблицу

Параметры

Model $Model: Модель, использующая этот бихевиор

Возвращаемое значение

boolean
true для продолжения, false для прерывания удаления

Переопределяет

ModelBehavior::afterDelete()

afterSave()source public

afterSave( Model $Model , boolean $created , array $options array() )

Метод после сохранения. Вызывается после всех сохранений

Переопределен для прозрачного управления установкой полей lft и rght только в том случае, если поле parent включено в параметры для сохранения.

Параметры

Model $Model: Модель, использующая этот бихевиор.
boolean $created: указывает, был ли узел, только что сохранённый, создан или обновлён
array $options необязательный array(): Опции, переданные из Model::save().

Возвращаемое значение

boolean
true при успехе, false при неудаче

Переопределяет

ModelBehavior::afterSave()

beforeDelete()source public

beforeDelete( Model $Model , boolean $cascade true )

Сохраняет запись, которую собираются удалить.

Это используется для удаления дочерних узлов в послеУдаления.

Параметры

Model $Model: Модель, использующая этот бихевиор.
boolean $cascade необязательный true: Если true, записи, зависящие от этой записи, также будут удалены

Возвращаемое значение

boolean

Переопределяет

ModelBehavior::beforeDelete()

beforeFind()source public

beforeFind( Model $Model , array $query )

Выполняется перед операцией find()

Параметры

Model $Model: Модель, использующая поведение
array $query: Параметры запроса, заданные Cake

Возвращаемое значение

array

Переопределяет

ModelBehavior::beforeFind()

beforeSave()source public

beforeSave( Model $Model , array $options array() )

Метод перед сохранением. Вызывается перед всеми сохранениями

Переопределен для прозрачного управления установкой полей lft и rght только в том случае, если поле parent включено в параметры для сохранения. Для вновь созданных узлов без родителя значения полей left и right устанавливаются непосредственно этим методом, минуя логику setParent.

Параметры

Model $Model: Модель, использующая этот бихевиор
array $options необязательный array(): Опции, переданные из Model::save().

Возвращаемое значение

boolean
true для продолжения, false для прерывания сохранения

См. также

Model::save()

Переопределяет

ModelBehavior::beforeSave()

childCount()source public

childCount( Model $Model , integer|string|boolean $id null , boolean $direct false )

Получить количество дочерних узлов

Если параметр direct установлен в true, считаются только непосредственные дочерние узлы (на основе поля parent_id). Если для параметра id передано false, считаются все узлы верхнего уровня или все узлы.

Параметры

Model $Model: Модель, использующая этот бихевиор
integer|string|boolean $id необязательный null: ID записи для чтения или false для чтения всех узлов верхнего уровня
boolean $direct необязательный false: Считать прямых или всех потомков

Возвращаемое значение

integer
количество дочерних узлов

Ссылка

http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::childCount

children()source public

children( Model $Model , integer|string $id null , boolean $direct false , string|array $fields null , string $order null , integer $limit null , integer $page 1 , integer $recursive null )

Получить дочерние узлы текущей модели

Если параметр direct установлен в true, возвращаются только непосредственные дочерние узлы (на основе поля parent_id). Если для параметра id передано false, считаются узлы верхнего уровня или все узлы (в зависимости от параметра direct).

Параметры

Model $Model: Модель, использующая этот бихевиор
integer|string $id необязательный null: ID записи для чтения
boolean $direct необязательный false: Возвращать только прямых или всех потомков
string|array $fields необязательный null: Строка или массив имён полей
string $order необязательный null: Условие ORDER BY SQL (например, "price DESC" или "name ASC"), по умолчанию – порядок дерева
integer $limit необязательный null: Оператор LIMIT SQL для подсчёта элементов на страницу.
integer $page необязательный 1: Номер страницы для доступа к постраничной информации
integer $recursive необязательный null: Глубина уровня для извлечения связанных записей

Возвращаемое значение

array
Массив дочерних узлов

Ссылка

http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::children

formatTreeList()source public

formatTreeList( Model $Model , array $results , array $options array() )

Форматирует результат вызова find() в иерархический массив, используемый для HTML-выпадающих списков.

Обратите внимание, что при использовании собственного вызова find() ожидается, что порядок будет «left» поле asc, чтобы получить тот же результат, что и при непосредственном использовании generateTreeList().

Опции:

'keyPath': Путь к ключу, например "{n}.Post.id"
'valuePath': Путь к значению, например "{n}.Post.title"
'spacer': Символ или символы, которые будут повторяться

Параметры

Model $Model: Модель, использующая это поведение
array $results: Массив результатов вызова find()
array $options необязательный array(): Опции

Возвращаемое значение

array
Ассоциативный массив записей, где id – ключ, а поле отображения – значение

generateTreeList()source public

generateTreeList( Model $Model , string|array $conditions null , string $keyPath null , string $valuePath null , string $spacer '_' , integer $recursive null )

Удобный метод для возвращения иерархического массива, используемого для HTML-выпадающих списков

Параметры

Model $Model: Модель, использующая этот метод
string|array $conditions необязательно null: SQL-условия в виде строки или массива ('поле' =>'значение',...)
string $keyPath необязательно null: Путь к ключу, например, "{n}.Post.id"
string $valuePath необязательно null: Путь к значению, например, "{n}.Post.title"
string $spacer необязательно '_': Символ или символы, которые будут повторяться
integer $recursive необязательно null: Глубина вложенности для получения связанных записей

Возвращаемое значение

array
Ассоциативный массив записей, где id — ключ, а поле отображения — значение

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::generateTreeList

getLevel()source public

getLevel( Model $Model , integer|string|null $id null )

Возвращает уровень вложенности узла в дереве.

Параметры

Model $Model: Модель, использующая этот метод
integer|string|null $id необязательно null: Первичный ключ записи, для которой нужно получить уровень.

Возвращаемое значение

integer|boolean
Целое число уровня или false, если узел не существует.

getParentNode()source public

getParentNode( Model $Model , integer|string $id null , string|array $fields null , integer $recursive null )

Получить родительский узел

считывает родительский id и возвращает этот узел

Параметры

Model $Model: Модель, использующая этот метод
integer|string $id необязательно null: ID записи для считывания
string|array $fields необязательно null: Поля для получения
integer $recursive необязательно null: Глубина вложенности для получения связанных записей

Возвращаемое значение

array|boolean
Массив данных для родительского узла

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::getParentNode

getPath()source public

getPath( Model $Model , integer|string|null $id null , string|array|null $fields null , integer|null $recursive null )

Получить путь к заданному узлу

Параметры

Model $Model: Модель, использующая этот метод
integer|string|null $id необязательно null: ID записи для считывания
string|array|null $fields необязательно null: Строка имени поля или массив имён полей
integer|null $recursive необязательно null: Глубина вложенности для получения связанных записей

Возвращаемое значение

array
Массив узлов от самого верхнего родителя до текущего узла

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::getPath

moveDown()source public

moveDown( Model $Model , integer|string|null $id null , integer|boolean $number 1 )

Переместить узел вниз, не изменяя родителя.

Если узел является последним дочерним элементом или является узлом верхнего уровня без последующего узла, этот метод вернёт false

Параметры

Model $Model: Модель, использующая этот метод
integer|string|null $id необязательно null: ID записи для перемещения
integer|boolean $number необязательно 1: Количество позиций для перемещения узла или true для перемещения в последнюю позицию

Возвращаемое значение

boolean
true при успехе, false при ошибке

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::moveDown

moveUp()source public

moveUp( Model $Model , integer|string|null $id null , integer|boolean $number 1 )

Переместить узел вверх, не изменяя родителя.

Если узел является первым дочерним элементом или является узлом верхнего уровня без предыдущего узла, этот метод вернёт false

Параметры

Model $Model: Модель, использующая этот метод
integer|string|null $id необязательно null: ID записи для перемещения
integer|boolean $number необязательно 1: Количество позиций для перемещения узла или true для перемещения в первую позицию

Возвращаемое значение

boolean
true при успехе, false при ошибке

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::moveUp

recover()source public

recover( Model $Model , string $mode 'parent' , string|integer|null $missingParentAction null )

Восстановить поврежденное дерево

Параметр mode используется для указания источника информации, который является действительным/правильным. Противоположный источник данных будет заполнен на основе этого источника информации. Например, если поля MPTT повреждены или пусты, с параметром $mode 'parent' будут использованы значения поля parent_id для заполнения полей left и right. Параметр missingParentAction применяется только к режиму "parent" и определяет, что делать, если поле parent содержит id, который отсутствует.

Параметры

Model $Model: Модель, использующая этот метод
string $mode необязательно 'parent': parent или tree
string|integer|null $missingParentAction необязательно null: 'return' — ничего не делать и вернуть, 'delete' — удалить или id родителя для установки как parent_id

Возвращаемое значение

boolean
true при успехе, false при ошибке

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::recover

removeFromTree()source public

removeFromTree( Model $Model , integer|string|null $id null , boolean $delete false )

Удалить текущий узел из дерева и переместить всех потомков на уровень выше.

Если параметр delete равен false, узел станет новым узлом верхнего уровня. В противном случае узел будет удалён после перемещения потомков (если они есть).

Параметры

Model $Model: Модель, использующая этот метод
integer|string|null $id необязательно null: ID записи для удаления
boolean $delete необязательно false: Удалить узел после перемещения потомков (если есть)

Возвращаемое значение

boolean
true при успехе, false при ошибке

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::removeFromTree

END_OF_DOCUMENT_MARKER

reorder()source public

reorder( Model $Model , array $options array() )

Метод переупорядочивания.

Переупорядочивает узлы (и дочерние узлы) дерева в соответствии с полем и направлением, указанными в параметрах. Этот метод не изменяет родителя узла.

Требуется валидное дерево, по умолчанию оно проверяется перед началом.

Параметры:

'id' идентификатор записи, используемый в качестве узла для переупорядочивания
'field' Поле, используемое для переупорядочивания, по умолчанию displayField
'order' Направление сортировки, либо DESC, либо ASC (по умолчанию ASC)
'verify' Проверять ли дерево перед переупорядочиванием. По умолчанию true.

Параметры

Model $Model: Модель, использующая этот метод
массив $options необязательно массив(): Массив параметров для переупорядочивания.

Возвращает

boolean
true при успехе, false при ошибке

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::reorder

setup()source public

setup( Model $Model , array $config array() )

Инициализация поведения Tree

Параметры

Model $Model: Модель, использующая это поведение
массив $config необязательно массив(): Массив параметров конфигурации.

Переопределяет

ModelBehavior::setup()

verify()source public

verify( Model $Model )

Проверка валидности текущего дерева.

Возвращает true, если дерево валидное, иначе массив (тип, неверный индекс слева/справа, сообщение)

Параметры

Model $Model: Модель, использующая это поведение

Возвращает

mixed

true, если дерево валидное или пустое, иначе массив (тип ошибки [индекс, узел], [неверный индекс слева/справа, id узла], сообщение)

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/behaviors/tree.html#TreeBehavior::verify

Методы, унаследованные от ModelBehavior

_addToWhitelist()source protected

_addToWhitelist( Model $model , string $field )

Если свойство $whitelist модели не пустое, $field будет добавлен в него. Примечание: этот метод следует использовать только в beforeValidate или beforeSave, чтобы гарантировать, что он изменяет whitelist только для текущей операции сохранения. Также убедитесь, что вы явно установили значение поля, которое вы разрешаете.

Параметры

Model $model: Модель, использующая это поведение
строка $field: Поле, которое нужно добавить в whitelist модели

afterFind()source public

afterFind( Model $model , mixed $results , boolean $primary false )

Обработчик после поиска. Может использоваться для модификации результатов, возвращаемых функцией find.

Параметры

Model $model: Модель, использующая это поведение
смешанный $results: Результаты операции поиска
логическое $primary необязательно false: Является ли эта модель запрашиваемой напрямую (по сравнению с запросом как ассоциация)

Возвращает

mixed
Значение массива заменит значение $results – любое другое значение будет проигнорировано.

afterValidate()source public

afterValidate( Model $model )

afterValidate вызывается сразу после проверки данных модели, вы можете использовать этот обработчик для выполнения любых необходимых очисток или подготовки данных

Параметры

Model $model: Модель, использующая это поведение

Возвращает

mixed
False остановит передачу этого события другим методам

beforeValidate()source public

beforeValidate( Model $model , array $options array() )

beforeValidate вызывается перед проверкой модели, вы можете использовать этот обработчик для добавления правил проверки поведения в массив validate модели. Возврат false позволит сделать проверку неудачной.

Параметры

Model $model: Модель, использующая это поведение
массив $options необязательно массив(): Параметры, переданные из Model::save().

Возвращает

mixed
False или null прервут операцию. Любой другой результат продолжит выполнение.

См. также

Model::save()

cleanup()source public

cleanup( Model $model )

Очистка любой инициализации, выполненной этим поведением в модели. Вызывается при динамическом отделении поведения от модели с помощью Model::detach().

Параметры

Model $model: Модель, использующая это поведение

См. также

BehaviorCollection::detach()

onError()source public

onError( Model $model , string $error )

Обработчик ошибок источника данных

Параметры

Model $model: Модель, использующая это поведение
строка $error: Ошибка, сгенерированная в DataSource

Методы, унаследованные от Object

__construct()source public

__construct( )

Конструктор, пустая операция

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойство $property этого объекта со свойством в определении $class. Значение свойства этого класса будет объединено поверх значения $class.

Это предоставляет часть магии DRY, предоставляемой CakePHP. Если вы хотите отключить ее, переопределите этот метод как пустую функцию.

Параметры

массив $properties: Имя свойств для объединения.
строка $class: Класс для объединения свойства с.
логическое $normalize необязательно true: Установите в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будут установлены только свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно массив(): Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число/строка $status необязательно 0: см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет объектно-ориентированный wrapper для call_user_func_array

Параметры

строка $method: Имя метода для вызова
массив $params необязательно массив(): Список параметров для использования при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

END_OF_DOCUMENT_MARKER ```

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения дополнительной информации о записи в журналы см. CakeLog::write().

Параметры

строка $msg: Сообщение журнала
целое число $type необязательно LOG_ERR: Константа типа ошибки. Определена в app/Config/core.php.
null|string|массив $scope необязательно null: Область(и), в которой создается сообщение журнала. Для получения дополнительной информации о областях ведения журнала см. CakeLog::config().

Возвращает

boolean
Успешность записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любого места. Может использоваться для связи контроллеров или подключения плагинов к основному приложению. requestAction можно использовать для возврата отрисованных представлений или получения значения возврата действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Следует использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

строка|массив $url: Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.
массив $extra необязательно массив(): Если массив включает ключ "return", он устанавливает AutoRender в true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

смешанный тип

Булево значение true или false при успешном/неуспешном выполнении или содержимое отрисованного действия, если в $extra установлен ключ 'return'.

toString()source public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по необходимости.

Возвращает

строка
Имя этого класса

Подробное описание свойств

$_defaultssource

protected массив

Значения по умолчанию

array(
    'parent' => 'parent_id', 'left' => 'lft', 'right' => 'rght', 'level' => null,
    'scope' => '1 = 1', 'type' => 'nested', '__parentChange' => false, 'recursive' => -1
)

$_deletedRowsource

protected массив

Используется для сохранения состояния между вызовами удаления.

array()

$errorssource

public массив

Ошибки

array()

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-TreeBehavior.html