Класс LogEngineRegistry

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

Пространство имён: Cake\Log

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

$_loaded protected

object[]

Карта загруженных объектов.

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

__debugInfo() public

Свойства объекта для отладки.
__get() public

Предоставление публичного чтения загруженных объектов.
__isset() public

Предоставление доступа isset к _loaded
__set() public

Устанавливает объект.
__unset() public

Удаляет объект.
_checkDuplicate() protected

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

Создание экземпляра логгера.
_resolveClassName() protected

Разрешение имени класса логгера.
_throwMissingClassError() protected

Выбрасывает исключение при отсутствии логгера.
count() public

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

Получение экземпляра загруженного объекта.
getIterator() public

Возвращает итератор массива.
has() public

Проверка загрузки данного объекта.
load() public

Загрузка/создание экземпляра объекта.
loaded() public

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

Нормализует массив объектов, создаёт массив для более лёгкой ленивой загрузки.
reset() public

Очистка загруженных экземпляров в регистре.
set() public

Установка объекта напрямую в регистр по имени.
unload() public

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

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

__debugInfo() public

__debugInfo(): array

Свойства объекта для отладки.

Возвращает

array

__get() public

__get(string $name): object|null

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

Параметры

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

Возвращает

object|null

__isset() public

__isset(string $name): bool

Предоставление доступа isset к _loaded

Параметры

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

Возвращает

bool

__set() public

__set(string $name, object $object): void

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

Параметры

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

Возвращает

void

__unset() public

__unset(string $name): void

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

Параметры

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

Возвращает

void

_checkDuplicate() protected

_checkDuplicate(string $name, array $config): void

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

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

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

Параметры

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

Возвращает

void

Выбрасывает

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

_create() protected

_create(string|object $class, string $alias, array $config): Psr\Log\LoggerInterface

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

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

Параметры

string|object $class: Имя класса или объект для создания.
string $alias: Псевдоним объекта.
array $config: Массив настроек для логгера.

Возвращает

Psr\Log\LoggerInterface

Выбрасывает

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

_resolveClassName() protected

_resolveClassName(string $class): string|null

Разрешение имени класса логгера.

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

Параметры

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

Возвращает

string|null

_throwMissingClassError() protected

_throwMissingClassError(string $class, string|null $plugin): void

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

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

Параметры

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

Возвращает

void

Выбрасывает

RuntimeException

count() public

count(): int

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

Возвращает

int

get() public

get(string $name): object

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

Параметры

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

Возвращает

object

Выбрасывает

RuntimeException
Если не загружен или не найден.

getIterator() public

getIterator(): Traversable

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

Возвращает

Traversable

has() public

has(string $name): bool

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

Параметры

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

Возвращает

bool

load() public

load(string $name, array $config = []): mixed

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

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

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

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

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

loaded() public

loaded(): string[]

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

Возвращает

string[]

normalizeArray() public

normalizeArray(array $objects): array[]

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

Параметры

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

Возвращает

array[]

reset() public

reset(): $this

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

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

Возвращает

$this

set() public

set(string $name, object $object): $this

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

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

Параметры

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

Возвращает

$this

unload() public

unload(string $name): $this

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

Если в этом реестре есть менеджер событий, объект также будет отделён от всех событий.

Параметры

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

Возвращает

$this

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

`$_loaded` protected

Карта загруженных объектов.

Тип

object[]

© 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/4.2/class-Cake.Log.LogEngineRegistry.html