Класс 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 опционально массив()

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

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

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

Имя объекта(ов) в формате ВерблюжийРегистр (строка или массив)

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

Имя объекта в формате ВерблюжьегоРегистра (string или array) Если строка, то используется второй параметр $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