Spec-Zone.ru › CakePHP 3.6

Класс LogEngineRegistry

Регистр загруженных лог-движков

Cake\Core\ObjectRegistry реализует Countable, IteratorAggregate
Extended by Cake\Log\LogEngineRegistry
Пространство имён: Cake\Log
Расположение: Log/LogEngineRegistry.php

Унаследованные свойства

  • _loaded

Краткое описание методов

  • _create() protected
    Создать экземпляр логгера.
  • _resolveClassName() protected
    Разрешить имя класса логгера.
  • _throwMissingClassError() protected
    Выбрасывает исключение, когда логгер отсутствует.
  • unload() public
    Удалить единственный логгер из реестра.

Подробное описание методов

_create()source protected

_create( string|Psr\Log\LoggerInterface $class , string $alias , array $settings )

Создать экземпляр логгера.

Часть шаблонового метода для Cake\Core\ObjectRegistry::load()

Параметры

string|Psr\Log\LoggerInterface $class
Имя класса или объект для создания.
string $alias
Псевдоним объекта.
array $settings
Массив настроек для логгера.

Возвращает

Psr\Log\LoggerInterface
Созданный класс логгера.

Исключения

RuntimeException
если объект не реализует правильный интерфейс.

_resolveClassName()source protected

_resolveClassName( string $class )

Разрешить имя класса логгера.

Часть шаблонового метода для Cake\Core\ObjectRegistry::load()

Параметры

string $class
Частичное имя класса для разрешения.

Возвращает

string|false
Либо правильное имя класса, либо false.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

Выбрасывает исключение, когда логгер отсутствует.

Часть шаблонового метода для Cake\Core\ObjectRegistry::load()

Параметры

string $class
Отсутствующее имя класса.
string $plugin
Плагин, в котором отсутствует логгер.

Исключения

RuntimeException

unload()source public

unload( string $name )

Удалить единственный логгер из реестра.

Параметры

string $name
Имя логгера.

Переопределяет

Cake\Core\ObjectRegistry::unload()

Методы, унаследованные от Cake\Core\ObjectRegistry

__debugInfo()source public

__debugInfo( )

Детали объекта для отладки.

Возвращает

array

__get()source public

__get( string $name )

Обеспечить публичный доступ для чтения к загруженным объектам

Параметры

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

Возвращает

mixed

__isset()source public

__isset( string $name )

Обеспечить доступ isset к _loaded

Параметры

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

Возвращает

boolean

__set()source public

__set( string $name , mixed $object )

Устанавливает объект.

Параметры

string $name
Имя свойства для установки.
mixed $object
Объект для установки.

__unset()source public

__unset( string $name )

Удаляет объект.

Параметры

string $name
Имя свойства для удаления.

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

Проверка на дублирование загрузки объектов.

Если загружается дубликат с различной конфигурацией, это неверно, и будет возбуждено исключение.

Возбуждается исключение, так как замена объекта не обновит какие-либо ссылки, которые могут иметь другие объекты. Кроме того, простое обновление конфигурации во время выполнения не является хорошим вариантом, так как мы можем пропустить важные логику конструктора, зависящую от конфигурации.

Параметры

string $name
Имя псевдонима в реестре.
array $config
Данные конфигурации для нового экземпляра.

Исключения

RuntimeException
При обнаружении дубликата.

count()source public

count( )

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

Возвращает

integer

Реализация

Countable::count()

get()source public

get( string $name )

Получить загруженный экземпляр объекта.

Параметры

string $name
Имя объекта.

Возвращает

object|null
Экземпляр объекта, если загружен, иначе null.

getIterator()source public

getIterator( )

Возвращает итератор массива.

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверка того, загружен ли данный объект или нет.

Параметры

string $name
Имя объекта для проверки.

Возвращает

boolean
True, если объект загружен, иначе false.

load()source public

load( string $objectName , array $config = [] )

Загружает/создаёт экземпляр объекта.

Возвратит экземпляр в реестре, если он уже существует. Если подкласс поддерживает события, можно использовать $config['enabled'] = false для исключения созданных объектов из регистрации для событий.

Пример Cake\Controller\Controller::$components. Можно задать псевдоним объекта, установив ключ 'className', например:

public $components = [
  'Email' => [
    'className' => '\App\Controller\Component\AliasedEmailComponent'
  ];
];

Все вызовы компонента Email будут использовать AliasedEmail вместо.

Параметры

string $objectName
Имя/класс объекта для загрузки.
array $config optional []
Дополнительные настройки для использования при загрузке объекта.

Возвращает

mixed

Исключения

Exception
Если класс не найден.

loaded()source public

loaded( )

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

Возвращает

array
Список имён объектов.
END_OF_DOCUMENT_MARKER

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

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

reset()source public

reset( )

Очистить загруженные экземпляры в реестре.

Если подкласс реестра имеет менеджер событий, объекты также будут отделены от событий.

Возвращает


$this

set()source public

set( string $objectName , object $object )

Установить объект напрямую в реестр по имени.

Если этот набор реализует события, переданный объект будет прикреплён к менеджеру событий

Параметры

строка $objectName
Имя объекта, который нужно установить в реестре.
объект $object
экземпляр для хранения в реестре

Возвращает


$this

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Log.LogEngineRegistry.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API