Класс LogEngineCollection

_getLogger()source protected static

_getLogger( string $loggerName )

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

Параметры

строка $loggerName

имя класса логгера в формате плагин.Имя_класса, который нужно создать.

Возвращает

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

Исключения

CakeLogException

load()source public

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

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

Параметры

строка $name

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

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

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

Возвращает

BaseLog
Экземпляр движка 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

Имя объекта(ов) в верхнем регистре с маленькой первой буквой (строка или массив)

enable()source public

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

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

Параметры

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

Имя объекта(ов) в верхнем регистре с маленькой первой буквой (строка или массив)

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

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

Параметры

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

Имя объекта

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

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

Возвращает

массив
Загруженные объекты

setPriority()source public

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

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

Параметры

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

Имя объекта(ов) в верхнем регистре с маленькой первой буквой (строка или массив) Если строка, используется второй параметр $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

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