Класс ArrayLog

Журнализатор массивов.

Собирает сообщения журнала в памяти. Предназначен в первую очередь для использования в тестировании, где использование mocks может быть сложным. Но также может быть использован в сценариях, где требуется захватить логи в коде приложения.

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

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

$_config protected

array

Конфигурация выполнения
$_configInitialized protected

bool

Установлено ли для свойства config значения по умолчанию
$_defaultConfig protected

array

Конфигурация по умолчанию для этого класса
$content protected

array

Захваченные сообщения

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

__construct() public

Метод __construct
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Считывает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_format() protected

Форматирует сообщение для записи в журнал.
_getFormattedDate() protected

Возвращает отформатированную дату в соответствии с форматом опции dateFormat.
alert() public

Необходимо немедленное действие.
clear() public

Сбросить внутреннее хранилище.
configShallow() public

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
critical() public

Критические условия.
debug() public

Подробная отладочная информация.
emergency() public

Система непригодна для использования.
error() public

Ошибки выполнения, которые не требуют немедленного действия, но обычно должны быть записаны в журнал и отслеживаться.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для этого конкретного ключа.
info() public

Интересные события.
levels() public

Получить уровни, которые интересуют этот журнализатор.
log() public

Реализует запись во внутреннее хранилище.
notice() public

Обычные, но значимые события.
read() public

Прочитать внутреннее хранилище
scopes() public

Получить области, которые интересуют этого журнализатора.
setConfig() public

Установить конфигурацию.
warning() public

Исключительные ситуации, которые не являются ошибками.

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

__construct() public

__construct(array $config = [])

Метод __construct

Параметры

array $config optional: Массив конфигурации

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Вызывает исключение

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Вызывает исключение

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_format() protected

_format(string $message, array $context = []): string

Форматирует сообщение для записи в лог.

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

Параметры

string $message: Сообщение для форматирования.
array $context optional: Дополнительная информация для сообщения лога.

Возвращает

string

_getFormattedDate() protected

_getFormattedDate(): string

Возвращает дату, отформатированную согласно заданному формату dateFormat параметра.

Эта функция влияет на FileLog или ConsoleLog формат информации о дате и времени.

Возвращает

string

alert() public

alert(string $message, mixed[] $context = array()): void

Необходимо немедленное действие.

Пример: Веб-сайт полностью недоступен, база данных недоступна и т.д. Это должно вызвать SMS-оповещения и разбудить вас.

Параметры

string $message
mixed[] $context optional

Возвращает

void

clear() public

clear(): void

Сбросить внутреннее хранилище.

Возвращает

void

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Слияние предоставленной конфигурации с существующей конфигурацией. В отличие от config() , который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

critical() public

critical(string $message, mixed[] $context = array()): void

Критические состояния.

Пример: Компонент приложения недоступен, неожиданное исключение.

Параметры

string $message
mixed[] $context optional

Возвращает

void

debug() public

debug(string $message, mixed[] $context = array()): void

Подробная отладочная информация.

Параметры

string $message
mixed[] $context optional

Возвращает

void

emergency() public

emergency(string $message, mixed[] $context = array()): void

Система неработоспособна.

Параметры

string $message
mixed[] $context optional

Возвращает

void

error() public

error(string $message, mixed[] $context = array()): void

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

Параметры

string $message
mixed[] $context optional

Возвращает

void

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Вызывает исключение

InvalidArgumentException

info() public

info(string $message, mixed[] $context = array()): void

Интересные события.

Пример: Пользователь вошёл в систему, журналы SQL.

Параметры

string $message
mixed[] $context optional

Возвращает

void

levels() public

levels(): array

Получить уровни, которые интересуют этот регистратор.

Возвращает

array

log() public

log(mixed $level, string $message, mixed[] $context = []): void

Реализует запись во внутреннее хранилище.

Параметры

mixed $level: Уровень серьезности лога, который вы создаете.
string $message: Сообщение, которое вы хотите залогировать.
mixed[] $context optional: Дополнительная информация о залогированном сообщении

Возвращает

void

См. также

Cake\Log\Log::$_levels

notice() public

notice(string $message, mixed[] $context = array()): void

Обычные, но значимые события.

Параметры

string $message
mixed[] $context optional

Возвращает

void

read() public

read(): string[]

Прочитать внутреннее хранилище

Возвращает

string[]

scopes() public

scopes(): array|false

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

Возвращает

array|false

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигурации.
mixed|null $value необязательно: Значение для установки.
bool $merge необязательно: Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

warning() public

warning(string $message, mixed[] $context = array()): void

Исключительные случаи, которые не являются ошибками.

Пример: Использование устаревших API, плохое использование API, нежелательные действия, которые не обязательно являются ошибками.

Параметры

string $message
mixed[] $context необязательно

Возвращает

void

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

`$_config` protected

Конфигурация во время выполнения

Тип

array

`$_configInitialized` protected

Установлена ли конфигурация с настройками по умолчанию?

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого класса

Тип

array

`$content` protected

Захваченные сообщения

Тип

array

© 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.Engine.ArrayLog.html