Класс 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

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

enable()source public

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

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

Параметры

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

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

логическое значение $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()

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

Возвращает

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

loaded()source public

loaded( string $name null )

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

Параметры

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

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

Возвращает

mixed

Если $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 необязательно array()

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

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

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

Возвращает

смешанное
Либо последнее результат, либо все результаты, если включена сборка результатов.

Выбрасывает

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

unload()source public

unload( string $name )

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

Параметры

строка $name

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

array()

array()

10