Класс LogEngineCollection

_getLoggerисходный код protected static

_getLogger( string $loggerName )

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

Параметры

строка $loggerName

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

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

mixed
boolean false при ошибке, строка имени класса, если поиск успешен.

Исключения

CakeLogException
CakeLogException

loadисходный код public

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

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

Параметры

строка $name

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

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

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

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

BaseLog
экземпляр движка BaseLog

Исключения

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

__getисходный код public

__get( string $name )

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

Параметры

строка $name

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

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

mixed
смешанный тип

__issetисходный код public

__isset( string $name )

Предоставление доступа isset к _loaded

Параметры

строка $name

Имя проверяемого объекта.

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

boolean
boolean

attachedисходный код public

attached( string $name null )

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

Устарело

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

Параметры

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

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

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

mixed
Если указано $name, возвращает булево значение состояния соответствующего объекта. В противном случае возвращает массив всех присоединенных объектов.

disableисходный код public

disable( string|array $name )

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

Параметры

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

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

enableисходный код public

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

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

Параметры

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

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

булево $prioritize необязательно true

Устанавливает приоритет включенного списка после включения объекта(ов)

enabledисходный код public

enabled( string $name null )

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

Параметры

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

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

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

mixed
Если указано $name, возвращает булево значение состояния соответствующего объекта. В противном случае возвращает массив всех активных объектов.

loadedисходный код public

loaded( string $name null )

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

Параметры

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

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

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

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

normalizeObjectArrayисходный код public static

normalizeObjectArray( array $objects )

Нормализует массив объектов, создаёт массив, который упрощает ленивую загрузку

Параметры

массив $objects

Массив дочерних объектов для нормализации.

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

array
Массив нормализованных объектов.

prioritizeисходный код public

prioritize( )

Устанавливает приоритет списка активных объектов

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

array
Список объектов с приоритетом

setисходный код public

set( string $name null , Object $object null )

Добавляет или перезаписывает экземпляр объекта в коллекции

Параметры

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

Имя объекта

Object $object необязательно null

Объект для использования

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

array
Загруженные объекты

setPriorityисходный код public

setPriority( string|array $name , integer|null $priority null )

Устанавливает приоритет для объекта или массива объектов

Параметры

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

Имя объекта(ов) в формате Верблюд (строка или массив). Если строка, используется второй параметр $priority; в противном случае должен быть ассоциативный массив с именами объектов в качестве ключей и значениями - устанавливаемыми приоритетами.

целое|null $priority необязательно null

Целое значение приоритета или null для значения по умолчанию

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

unloadsource public

unload( string $name )

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

Параметры

string $name

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

array()

array()

10