Класс 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 deprecated

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

Записать ошибку в подсистему журнала Cake
logException() public

Записать исключение в подсистему журнала Cake
logMessage() public deprecated

Записать сообщение об ошибке в логгер ошибок.
setConfig() public

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

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

__construct() public

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

Конструктор

Параметры

array<string, mixed> $config необязательно: Массив конфигурации.

_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 необязательно: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Выбрасывает

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

Параметры

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

Возвращает

$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 необязательно: Ключ для получения или null для всей конфигурации.
mixed $default необязательно: Значение по умолчанию, если ключ не найден.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getMessage() protected

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

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

Параметры

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

Возвращает

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 необязательно: Текущий запрос, если доступен.

Возвращает

bool

logError() public

logError(Cake\Error\PhpError $error, Psr\Http\Message\ServerRequestInterface $request = null, bool $includeTrace = false): void

Записать ошибку в подсистему логирования Cake

Параметры

Cake\Error\PhpError $error: Ошибка для записи
Psr\Http\Message\ServerRequestInterface $request необязательно: Запрос, если контекст HTTP.
bool $includeTrace необязательно: Должно ли сообщение журнала включать трассировку стека

Возвращает

void

logException() public

logException(Throwable $exception, Psr\Http\Message\ServerRequestInterface|null $request = null, bool $includeTrace = false): void

Записывает исключение в подсистему логирования Cake

Параметры

Throwable $exception: Исключение для записи сообщения.
Psr\Http\Message\ServerRequestInterface|null $request необязательно: Текущий запрос, если доступен.
bool $includeTrace необязательно: Включать ли трассировку стека в журнале.

Возвращает

void

logMessage() public

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

Записать сообщение об ошибке в логирования ошибок.

Параметры

string|int $level: Уровень логирования
string $message: Сообщение для записи.
array $context необязательно: Контекст.

Возвращает

bool

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
При попытке установить неверный ключ.

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

`$_config` protected

Конфигурация runtime

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

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.4/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 deprecated

logError() public

logException() public

logMessage() public deprecated

setConfig() public

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

__construct() public

Параметры

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

getMessage() protected

Параметры

Возвращает

getRequestContext() public

Параметры

Возвращает

log() public

Параметры

Возвращает

logError() public

Параметры

Возвращает

logException() public

Параметры

Возвращает

logMessage() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Выбрасывает

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected