Класс ObjectCollection

__get()source public

__get( string $name )

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

Параметры

строка $name

Имя свойства для чтения

Возвращает

mixed

__isset()source public

__isset( string $name )

Обеспечивает доступ isset к _loaded

Параметры

строка $name

Имя объекта, который проверяется.

Возвращает

boolean

attached()source public

attached( string $name null )

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

Устаревший

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

Параметры

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

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

Возвращает

mixed

Если $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

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

Возвращает

mixed

Если $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

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

Возвращает

mixed

Если $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