Class LogEngineRegistry

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

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

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

$_loaded protected

array<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<string, mixed>

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

Возвращает

array<string, mixed>

__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<string, mixed> $config): void

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

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

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

Параметры

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

Возвращает

void

Выбрасывает

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

_create() protected

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

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

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

Параметры

object|string $class: Имя класса или объект для создания.
string $alias: Псевдоним объекта.
array<string, mixed> $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<string, mixed> $config = []): mixed

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

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

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

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

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

loaded() public

loaded(): array<string>

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

Возвращает

array<string>

normalizeArray() public

normalizeArray(array $objects): array<string, array>

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

Параметры

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

Возвращает

array<string, 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

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

Тип

array<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.4/class-Cake.Log.LogEngineRegistry.html