Класс ObjectCollection

__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 указан, возвращает булевое значение статуса соответствующего объекта. В противном случае возвращает массив всех активных объектов.

load()source abstract public

load( string $name , array $options array() )

Загружает новый объект в коллекцию. Может выбросить различные исключения

Реализации этого класса поддерживают флаг $options['enabled'], который включает/отключает загруженный объект.

Параметры

строка $name

Имя загружаемого объекта.

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

Массив параметров конфигурации для конструирования объекта.

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

CakeObject
созданный объект

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

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

array()

array()

10