Класс BehaviorCollection

attach()source public

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

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

Устарело

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

Параметры

строка $behavior

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

массив $config необязательно массив()

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

detach()source public

detach( string $name )

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

Устарело

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

Параметры

строка $name

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

dispatchMethod()source public

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

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

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

Параметры

Model $model

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

строка $method

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

массив $params необязательно массив()

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

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

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

Возвращает

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

hasMethod()source public

hasMethod( string $method , boolean $callback false )

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

Параметры

строка $method

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

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

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

Возвращает

смешанное

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

Реализация

CakeEventListener::implementedEvents()

init()source public

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

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

Параметры

строка $modelName

Имя модели.

массив $behaviors необязательно массив()

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

load()source public

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

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

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

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

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

Параметры

строка $behavior

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

массив $config необязательно массив()

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

Возвращает

boolean
Истина при успехе, ложь при ошибке

Выбрасывает

MissingBehaviorException
когда поведение не может быть найдено.

methods()source public

methods( )

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

Возвращает

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

unload()source public

unload( string $name )

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

Параметры

строка $name

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

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

ObjectCollection::unload()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанное

__isset()source public

__isset( string $name )

Предоставляет доступ isset к _loaded

Параметры

строка $name

Имя проверяемого объекта.

Возвращает

boolean

attached()source public

attached( string $name null )

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

Устарело

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

Параметры

строка $name необязательно null

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

Возвращает

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

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

disable()source public

disable( string|array $name )

Отключает обратные вызовы для объекта или массива объектов. Публичные методы объектов всё ещё вызываемы как обычно.

Параметры

строка|массив $name

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

enable()source public

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

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

Параметры

строка|массив $name

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

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

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

enabled()source public

enabled( string $name null )

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

Параметры

строка $name необязательно null

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

Возвращает

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

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

loaded()source public

loaded( string $name null )

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

Параметры

строка $name необязательно null

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

Возвращает

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

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

normalizeObjectArray()source public static

normalizeObjectArray( array $objects )

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

Параметры

массив $objects

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

Возвращает

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

prioritize()source public

prioritize( )

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

Возвращает

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

set()source public

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

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

Параметры

строка $name необязательно null

Имя объекта

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

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

Возвращает

массив
Загруженные объекты

setPriority()source public

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

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

Параметры

строка|массив $name

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

целое число|null $priority необязательно null

Целое число приоритета для установки или null для значения по умолчанию

trigger()source public

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

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

Опции

• breakOn Установите значение или значения, на которых должно прекратиться распространение обратного вызова. Может быть скалярным значением или массивом значений для прерывания. По умолчанию false.

• break Установите в true для включения прерывания. При прерывании обратного вызова возвращается последнее возвращённое значение. Если используется в сочетании с collectReturn, возвращаются собранные результаты. По умолчанию false.

• collectReturn Установите в true, чтобы собрать возвращаемое значение каждого объекта в массив. Этот массив возвращаемых значений будет возвращён вызовом trigger(). По умолчанию false.

• modParams Позволяет каждому объекту модифицировать параметры для следующего объекта. Установка modParams в целое число позволит вам модифицировать параметр с этим индексом. Любое ненулевое значение будет модифицировать указанный индекс параметра. По умолчанию false.

Параметры

строка|CakeEvent $callback

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

массив $params необязательно array()

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

массив $options необязательно array()

Массив опций.

Возвращает

смешанный тип
Либо последнее возвращаемое значение, либо все значения, если включена collectReturn.

Исключения

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

array()

array()

null