Spec-Zone.ru › CakePHP 3.3

Класс LogEngineRegistry

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

Cake\Core\ObjectRegistry
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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

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

Выбрасывает

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

get()source public

get( string $name )

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

Параметры

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

Возвращает

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

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

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

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

reset()source public

reset( )

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

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

set()source public

set( string $objectName , object $object )

Непосредственно установить объект в реестр по имени.

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

Параметры

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

© 2005–2017 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.3/class-Cake.Log.LogEngineRegistry.html

Spec-Zone.ru

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