Class BaseLog

Базовый класс логирования.

Абстрактный
Пространство имен: Cake\Log\Engine

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

$_config protected

array<string, mixed>

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

bool

Указатель, был ли свойство конфигурации уже настроен с параметрами по умолчанию
$_defaultConfig protected

array<string, mixed>

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

Cake\Log\Formatter\AbstractFormatter

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

__construct() public

Метод __construct
_configDelete() protected

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

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

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

Форматирует сообщение для логирования.
alert() public

Требуются немедленные действия.
configShallow() public

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

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

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

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

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

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

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

Интересные события.
interpolate() protected

Заменяет плейсхолдеры в строке сообщения значениями контекста.
levels() public

Получить уровни, интересующие этот логгер.
log() public

Записывает лог с произвольным уровнем.
notice() public

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

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

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

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

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct(array<string, mixed> $config = [])

Метод __construct

Параметры

array<string, mixed> $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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $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

alert() public

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

Требуются немедленные действия.

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

Параметры

string $message
mixed[] $context optional

Возвращает

void

configShallow() public

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

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

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

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

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

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

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

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

Параметры

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

interpolate() protected

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

Заменяет заполнители в строке сообщения значениями контекста.

Параметры

string $message: Форматированная строка
array $context optional: Контекст для значений заполнителей.

Возвращает

string

levels() public

levels(): array<string>

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

Возвращает

array<string>

log() public

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

Регистрирует с произвольным уровнем.

Параметры

mixed $level
string $message
mixed[] $context optional

Возвращает

void

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

Psr\Log\InvalidArgumentException

notice() public

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

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

Параметры

string $message
mixed[] $context optional

Возвращает

void

scopes() public

scopes(): array<string>|false

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

Возвращает

array<string>|false

setConfig() public

setConfig(array<string, mixed>|string $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']);

Параметры

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

`$_configInitialized` protected

Указывает, была ли конфигурация свойств уже настроена значениями по умолчанию

Тип

bool

`$_defaultConfig` protected

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

Тип

array<string, mixed>

`$formatter` protected

Тип

Cake\Log\Formatter\AbstractFormatter

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

Class BaseLog

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_format() protected deprecated

alert() public

configShallow() public

critical() public

debug() public

emergency() public

error() public

getConfig() public

getConfigOrFail() public

info() public

interpolate() protected

levels() public

log() public

notice() public

scopes() public

setConfig() public

warning() public

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

__construct() public

Параметры

_configDelete() protected

Параметры

Возвращает

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

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

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

_format() protected

Параметры

Возвращает

alert() public

Параметры

Возвращает

configShallow() public

Параметры

Возвращает

critical() public

Параметры

Возвращает

debug() public

Параметры

Возвращает

emergency() public

Параметры

Возвращает

error() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

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

info() public

Параметры

Возвращает

interpolate() protected

Параметры

Возвращает

levels() public

Возвращает

log() public

Параметры

Возвращает

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

notice() public

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$formatter` protected