Класс LogEngineCollection

_getLogger()source protected static

_getLogger( string $loggerName )

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

Параметры

строка $loggerName

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

Возвращает

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

Исключения

CakeLogException

load()source public

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

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

Параметры

строка $name

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

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

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

Возвращает

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

Исключения

CakeLogException
при отсутствии метода write у класса логгера

__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 , CakeObject $object null )

Добавляет или перезаписывает созданный объект в коллекцию

Параметры

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

Имя объекта

CakeObject $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).

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

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

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

Массив параметров.

Возвращает

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

Исключения

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

unload()source public

unload( string $name )

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

Параметры

строка $name

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