Класс ComponentCollection

getController()source public

getController( )

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

Возвращает

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

Реализация

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

Имя объекта(ов) с большой буквы (строка или массив) для отключения

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( )

Приоритетизация списка активных объектов

Возвращает

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 с индексом, который не существует.

unload()source public

unload( string $name )

Имя объекта, который нужно удалить из коллекции

Параметры

string $name

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

null