Класс ErrorLogger

Записывать ошибки и необработанные исключения в Cake\Log\Log

Пространство имен: Cake\Error

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

$_config protected

array<string, mixed>

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

bool

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

array<string, mixed>

Значения конфигурации по умолчанию.

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

__construct() public

Конструктор
_configDelete() protected

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

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

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

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

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

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

Генерирует сообщение для исключения
getRequestContext() public

Получает контекст запроса для трассировки ошибки/исключения.
log() public

Логирует ошибку для исключения с необязательным контекстом запроса.
logMessage() public

Логирует сообщение об ошибке в логгер ошибок.
setConfig() public

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

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

__construct() public

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

Конструктор

Parameters

array<string, mixed> $config optional: Массив конфигурации.

_configDelete() protected

_configDelete(string $key): void

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

Parameters

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

Returns

void

Throws

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

_configRead() protected

_configRead(string|null $key): mixed

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

Parameters

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

Returns

mixed

_configWrite() protected

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

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

Parameters

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

Returns

void

Throws

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

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']);

Parameters

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

Returns

$this

getConfig() public

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

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

Usage

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Parameters

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

Returns

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Parameters

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

Returns

mixed

Throws

InvalidArgumentException

getMessage() protected

getMessage(Throwable $exception, bool $isPrevious = false): string

Генерирует сообщение для исключения

Parameters

Throwable $exception: Исключение, для которого нужно залогировать сообщение.
bool $isPrevious optional: False для исходного исключения, true для предыдущего

Returns

string

getRequestContext() public

getRequestContext(Psr\Http\Message\ServerRequestInterface $request): string

Получает контекст запроса для трассировки ошибки/исключения.

Parameters

Psr\Http\Message\ServerRequestInterface $request: Запрос, из которого нужно читать.

Returns

string

log() public

log(Throwable $exception, Psr\Http\Message\ServerRequestInterface|null $request = null): bool

Логирует ошибку для исключения с необязательным контекстом запроса.

Parameters

Throwable $exception
Psr\Http\Message\ServerRequestInterface|null $request optional

Returns

bool

logMessage() public

logMessage(string|int $level, string $message, array $context = []): bool

Логирует сообщение об ошибке в логгер ошибок.

Parameters

string|int $level
string $message
array $context optional

Returns

bool

setConfig() public

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

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

Usage

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

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

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

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

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

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

Parameters

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

Returns

$this

Throws

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

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

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

Значения конфигурации по умолчанию.

skipLog Список исключений, для которых не нужно регистрировать логи. Исключения, которые расширяют одно из перечисленных исключений, также не будут регистрироваться.
trace Включать ли в логах отладки трассировки стека?

Тип

array<string, mixed>

© 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.3/class-Cake.Error.ErrorLogger.html

Класс ErrorLogger

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

getConfig() public

getConfigOrFail() public

getMessage() protected

getRequestContext() public

log() public

logMessage() public

setConfig() public

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

__construct() public

Parameters

_configDelete() protected

Parameters

Returns

Throws

_configRead() protected

Parameters

Returns

_configWrite() protected

Parameters

Returns

Throws

configShallow() public

Parameters

Returns

getConfig() public

Usage

Parameters

Returns

getConfigOrFail() public

Parameters

Returns

Throws

getMessage() protected

Parameters

Returns

getRequestContext() public

Parameters

Returns

log() public

Parameters

Returns

logMessage() public

Parameters

Returns

setConfig() public

Usage

Parameters

Returns

Throws

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected