Класс ComponentCollection

getController()source public

getController( )

Получить контроллер, связанный с коллекцией.

Возвращает

Controller
Экземпляр контроллера

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

Реализация

CakeEventListener::implementedEvents()

init()source public

init( Controller $Controller )

Инициализирует все компоненты для контроллера. Присоединяет ссылку каждого компонента к контроллеру.

Параметры

Controller $Controller

Контроллер для инициализации компонентов.

load()source public

load( string $component , array $settings array() )

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

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

public $components = array(
  'Email' => array(
    'className' => 'AliasedEmail'
  );
);

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

Параметры

строка $component

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

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

Настройки для компонента.

Возвращает

Component
Объект компонента, либо уже загруженный компонент, либо новый.

Выбрасывает

MissingComponentException
если компонент не найден

setController()source public

setController( Controller $Controller )

Установить контроллер, связанный с коллекцией.

Параметры

Controller $Controller

Устанавливаемый контроллер

__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 вместо этого.

Параметры

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

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

Возвращает

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

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

disable()source public

disable( string|array $name )

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

Параметры

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

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

enable()source public

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

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

Параметры

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

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

булево значение $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 , Object $object null )

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

Параметры

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

Имя объекта

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

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

Возвращает

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

setPriority()source public

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

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

Параметры

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

Имя объекта в формате CamelCase (строка или массив). Если строка, то используется второй параметр $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 необязательно массив()

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

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

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

Возвращает

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

Вызывает исключение

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

unload()source public

unload( string $name )

Имя объекта для удаления из коллекции

Параметры

строка $name

Имя объекта для удаления.

null