Spec-Zone.ru › CakePHP 3.5

Класс LogEngineRegistry

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

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

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

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

reset()source public

reset( )

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

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

Возвращает


$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

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

Возвращает


$this

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

Spec-Zone.ru

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