Класс ErrorLogger

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

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

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

$_config protected

array

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

bool

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

array

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

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

__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 $config = [])

Конструктор

Параметры

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
при попытке перезаписи существующей конфигурации

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

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

getMessage() protected

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

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

Параметры

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

Возвращает

string

getRequestContext() public

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

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

Параметры

Psr\Http\Message\ServerRequestInterface $request: Запрос для чтения.

Возвращает

string

log() public

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

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

Параметры

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

Возвращает

bool

logMessage() public

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

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

Параметры

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

Возвращает

bool

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 optional: Значение для установки.
bool $merge optional: Выполнять рекурсивное объединение или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Вызывает

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

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

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

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

Тип

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.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

Параметры

_configDelete() protected

Параметры

Возвращает

Вызывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Вызывает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Вызывает

getMessage() protected

Параметры

Возвращает

getRequestContext() public

Параметры

Возвращает

log() public

Параметры

Возвращает

logMessage() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Вызывает

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected