Класс BehaviorCollection

attach()source public

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

Обратная совместимость с алиасом load()

Устаревшее

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

Параметры

строка $behavior

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

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

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

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 необязательно array()

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

логическое значение $strict необязательно false

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

Возвращает

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

hasMethod()source public

hasMethod( string $method , boolean $callback false )

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

Параметры

строка $method

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

логическое значение $callback необязательно false

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

Возвращает

смешанный

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

Реализация

CakeEventListener::implementedEvents()

init()source public

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

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

Параметры

строка $modelName

Имя модели.

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

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

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 необязательно array()

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

Возвращает

логическое значение
True при успехе, false при ошибке

Выбрасывает

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

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

Возвращает

логическое значение

attached()source public

attached( string $name null )

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

Устаревшее

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

Параметры

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

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

Возвращает

mixed

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

disable()source public

disable( string|array $name )

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

Параметры

string|array $name

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

enable()source public

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

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

Параметры

string|array $name

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

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

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

enabled()source public

enabled( string $name null )

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

Параметры

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

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

Возвращает

mixed

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

loaded()source public

loaded( string $name null )

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

Параметры

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

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

Возвращает

mixed

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

normalizeObjectArray()source public static

normalizeObjectArray( array $objects )

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

Параметры

array $objects

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

Возвращает

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

prioritize()source public

prioritize( )

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

Возвращает

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

set()source public

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

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

Параметры

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

Имя объекта.

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

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

Возвращает

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

setPriority()source public

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

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

Параметры

string|array $name

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

integer|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.

Параметры

string|CakeEvent $callback

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

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

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

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

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

Возвращает

mixed
Либо последнее значение, либо все значения, если collectReturn включён.

Выбрасывает

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

array()

array()

null