Класс LogEngineCollection

_getLogger()source protected static

_getLogger( string $loggerName )

Попытка импорта класса логгера из различных путей. Проверяет, что класс логгера также реализует метод записи.

Параметры

строка $loggerName

имя плагина.имя_класса логгерского класса, который необходимо создать.

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

смешанное
логическое значение false при любых ошибках, имя класса для использования, если поиск был успешным.

Исключения

CakeLogException

load()source public

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

Загружает/создаёт лог-движок.

Параметры

строка $name

идентификатор экземпляра

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

Настройки для лог-движка

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

BaseLog
Экземпляр базового лог-движка

Исключения

CakeLogException
если класс логгера не реализует метод записи

__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

Имя объектов(ов) в формате CamelCase (строка или массив)

enable()source public

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

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

Параметры

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

Имя объекта(ов) в формате CamelCase (строка или массив)

булево $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

Имя объекта(ов) в формате 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.

Параметры

string|CakeEvent $callback

Метод для вызова на всех объектах. Предполагается, что все объекты реализуют вызываемый метод. Если предоставлен экземпляр CakeEvent, имя события будет обработано для получения имени обратного метода. Это выполняется путем получения последнего слова после точки в имени события (например, Model.afterSave событие вызовет обратный метод afterSave).

array $params optional array()

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

array $options optional array()

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

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

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

Исключения

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

unload()source public

unload( string $name )

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

Параметры

string $name

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