Класс BehaviorCollection

attachисходный код public

attach( string $behavior , array $config array() )

Обратный совместимый псевдоним для load()

Устарело

3.0.0 Будет удалено в 3.0. Заменено на load().

Параметры

string $behavior

Имя поведения.

array $config необязательно array()

Параметры конфигурации.

detachисходный код public

detach( string $name )

Обратный совместимый псевдоним для unload()

Устарело

3.0.0 Будет удалено в 3.0. Используйте unload вместо этого.

Параметры

string $name

Имя поведения

dispatchMethodисходный код public

dispatchMethod( Model $model , string $method , array $params array() , boolean $strict false )

Отправляет метод поведения. Вызовет либо обычные методы, либо сопоставленные методы.

Если метод не обрабатывается BehaviorCollection, и $strict равен false, возвращается специальное значение array('unhandled'), чтобы указать, что метод не найден.

Параметры

Model $model

Модель, на которой изначально был вызван метод.

string $method

Вызванный метод.

array $params необязательно array()

Параметры для вызываемого метода.

boolean $strict необязательно false

Если методы не найдены, сгенерировать ошибку.

Возвращает

array
Все методы для всех прикрепленных к этому объекту поведений

hasMethodисходный код public

hasMethod( string $method , boolean $callback false )

Проверяет, реализует ли поведение в этой коллекции предоставленный метод. Также проверяет mappedMethods.

Параметры

string $method

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

boolean $callback необязательно false

Возвратить обратный вызов для метода.

Возвращает

mixed
Если $callback равен false, будет возвращено boolean значение, если true, будет возвращен массив с информацией об обратном вызове. Для сопоставленных методов массив будет содержать 3 элемента.

implementedEventsисходный код public

implementedEvents( )

Возвращает реализованные события, которые будут маршрутизированы в функцию триггера для их отдельной отправки для каждого поведения.

Возвращает

array
массив

Реализация

CakeEventListener::implementedEvents()

initисходный код public

init( string $modelName , array $behaviors array() )

Присоединяет объект модели и загружает список поведений

Параметры

string $modelName

Имя модели.

array $behaviors необязательно array()

Список поведений.

loadисходный код public

load( string $behavior , array $config array() )

Загружает поведение в коллекцию. Вы можете использовать $config['enabled'] = false для загрузки поведения с отключенными обратными вызовами. По умолчанию обратные вызовы включены. Отключенные поведения все еще могут использоваться как обычно.

Вы можете использовать алиас своего поведения как существующего поведения, установив ключ 'className', например:

public $actsAs = array(
  'Tree' => array(
    'className' => 'AliasedTree'
  );
);

Все вызовы к поведению Tree будут использовать AliasedTree вместо этого.

Параметры

string $behavior

Имя поведения в формате CamelCase для загрузки

array $config необязательно array()

Параметры конфигурации поведения

Возвращает

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

Исключения

MissingBehaviorException
если поведение не найдено.

methodsисходный код public

methods( )

Получает список методов прикрепленных поведений, т.е. все публичные методы, не являющиеся обратными вызовами. Это не включает mappedMethods.

Возвращает

array
Все публичные методы для всех прикрепленных к этой коллекции поведений

unloadисходный код public

unload( string $name )

Отсоединяет поведение от модели

Параметры

string $name

Имя поведения в формате CamelCase для удаления

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

ObjectCollection::unload()

__getисходный код public

__get( string $name )

Обеспечение публичного чтения загруженных объектов

Параметры

string $name

Имя свойства для чтения

Возвращает

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

__issetисходный код public

__isset( string $name )

Обеспечение доступа isset к _loaded

Параметры

string $name

Имя объекта, который проверяется.

Возвращает

boolean
bool

attachedисходный код public

attached( string $name null )

Получает список прикрепленных объектов или статус прикрепления заданного объекта

Устарело

3.0.0 Будет удалено в 3.0. Используйте loaded вместо этого.

Параметры

string $name необязательно null

Необязательно. Имя объекта для проверки состояния. Если опущено, возвращает массив текущих прикрепленных объектов.

Возвращает

mixed
Если $name указан, возвращает boolean статус соответствующего объекта. В противном случае возвращает массив всех прикрепленных объектов.

disableисходный код public

disable( string|array $name )

Отключает обратные вызовы для объекта или массива объектов. Публичные методы объекта по-прежнему могут вызываться как обычно.

Параметры

string|array $name

Имя объекта(ов) в формате CamelCase для отключения (строка или массив)

enableисходный код public

enable( string|array $name , boolean $prioritize true )

Включает обратные вызовы для объекта или массива объектов

Параметры

string|array $name

Имя объекта(ов) в формате CamelCase для включения (строка или массив)

boolean $prioritize необязательно true

Устанавливает приоритет списка включенных элементов после включения объекта(ов)

enabledsource public

enabled( string $name null )

Получает список активных объектов или текущий статус отдельного объекта

Параметры

string $name необязательно null

Необязательно. Название объекта, статус которого нужно проверить. Если опущено, возвращает массив активных объектов.

Возвращает

mixed
Если задан $name, возвращает булевый статус соответствующего объекта. В противном случае, возвращает массив всех активных объектов.

loadedsource public

loaded( string $name null )

Получает список загруженных объектов или загружен ли данный объект

Параметры

string $name необязательно null

Необязательно. Название объекта, статус которого нужно проверить. Если опущено, возвращает массив загруженных объектов.

Возвращает

mixed
Если задан $name, возвращает булевый статус соответствующего объекта. В противном случае, возвращает массив всех загруженных объектов.

normalizeObjectArraysource public static

normalizeObjectArray( array $objects )

Нормализует массив объектов, создаёт массив, который упрощает ленивую загрузку

Параметры

array $objects

Массив дочерних объектов для нормализации.

Возвращает

array
Массив нормализованных объектов.

prioritizesource public

prioritize( )

Устанавливает приоритет списка активных объектов

Возвращает

array
Список объектов с приоритетами

setsource public

set( string $name null , Object $object null )

Добавляет или перезаписывает экземпляр объекта в коллекцию

Параметры

string $name необязательно null

Имя объекта

Object $object необязательно null

Объект для использования

Возвращает

array
Загруженные объекты

setPrioritysource public

setPriority( string|array $name , integer|null $priority null )

Устанавливает приоритет для объекта или массива объектов

Параметры

string|array $name

Имя объекта с использованием CamelCase (строка или массив). Если строка, используется второй параметр $priority. В противном случае, это ассоциативный массив с именами объектов в качестве ключей и приоритетами в качестве значений.

integer|null $priority необязательно null

Целочисленный приоритет или null для значения по умолчанию.

triggersource public

trigger( string|CakeEvent $callback , array $params array() , array $options array() )

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

Параметры

• breakOn Устанавливается значением или значениями, на которых должна остановиться передача обратного вызова. Может быть скалярным значением или массивом значений. По умолчанию false.
• break Устанавливается в true для включения возможности остановки. Когда обратный вызов прерывается, возвращается последнее возвращённое значение. Если используется в сочетании с collectReturn, будут возвращены собранные результаты. По умолчанию false.
• collectReturn Устанавливается в true для сбора возвращаемых значений каждого объекта в массив. Этот массив значений возврата будет возвращён вызовом trigger(). По умолчанию false.
• modParams Позволяет каждому объекту изменять параметры для следующего объекта. Установка modParams в целое число позволит изменить параметр с указанным индексом. Любое ненулевое значение будет изменять параметр с указанным индексом. По умолчанию false.

Параметры

string|CakeEvent $callback

Метод для вызова для всех объектов. Предполагается, что все объекты реализуют вызываемый метод. Если предоставлен экземпляр CakeEvent, то имя события будет обработано, чтобы получить имя обратного вызова. Это делается путём получения последнего слова после любого символа точки в имени события (например, событие Model.afterSave вызовет обратный вызов afterSave).

array $params необязательно array()

Массив параметров для вызываемого обратного вызова.

array $options необязательно array()

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

Возвращает

mixed
Либо последнее результат, либо все результаты, если collectReturn включен.

Исключения

CakeException
при использовании modParams с индексом, который не существует.

array()

array()

null

array()

array()

10