Класс ErrorHandlerMiddleware

Обработка ошибок middleware.

Перехватывает исключения и преобразует их в HTML или соответствующие страницы ошибок с помощью CakePHP ExceptionRenderer.

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

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

$_config protected

array<string, mixed>

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

bool

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

array<string, mixed>

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

Cake\Error\ErrorHandler|null

Экземпляр обработчика ошибок.

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

__construct() public

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

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

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

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

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

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

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

Получить экземпляр обработчика ошибок
handleException() public

Обрабатывает исключение и генерирует ответ об ошибке
handleInternalError() protected

Обрабатывает внутренние ошибки.
handleRedirect() public

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

Оборачивает оставшиеся средства обработки с обработкой ошибок.
setConfig() public

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

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

__construct() public

__construct(Cake\Error\ErrorHandler|array $errorHandler = [])

Конструктор

Параметры

Cake\Error\ErrorHandler|array $errorHandler optional: Экземпляр обработчика ошибок или массив конфигурации.

Исключения

InvalidArgumentException

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

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

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

getErrorHandler() protected

getErrorHandler(): Cake\Error\ErrorHandler

Получить экземпляр обработчика ошибок

Возвращаемое значение

Cake\Error\ErrorHandler

handleException() public

handleException(Throwable $exception, Psr\Http\Message\ServerRequestInterface $request): Psr\Http\Message\ResponseInterface

Обрабатывает исключение и генерирует ответ об ошибке

Параметры

Throwable $exception: Исключение для обработки.
Psr\Http\Message\ServerRequestInterface $request: Запрос.

Возвращаемое значение

Psr\Http\Message\ResponseInterface

handleInternalError() protected

handleInternalError(): Psr\Http\Message\ResponseInterface

Обрабатывает внутренние ошибки.

Возвращаемое значение

Psr\Http\Message\ResponseInterface

handleRedirect() public

handleRedirect(Cake\Http\Exception\RedirectException $exception): Psr\Http\Message\ResponseInterface

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

Параметры

Cake\Http\Exception\RedirectException $exception: Исключение для обработки

Возвращаемое значение

Psr\Http\Message\ResponseInterface

process() public

process(ServerRequestInterface $request, RequestHandlerInterface $handler): Psr\Http\Message\ResponseInterface

Оборачивает оставшиеся средства обработки с обработкой ошибок.

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

Параметры

ServerRequestInterface $request: Запрос.
RequestHandlerInterface $handler: Обработчик запросов.

Возвращаемое значение

Psr\Http\Message\ResponseInterface

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

Возвращаемое значение

$this

Исключения

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

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

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

Игнорируется, если конструктору передан экземпляр ErrorHandler.

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

'skipLog' => ['Cake\Error\NotFoundException', 'Cake\Error\UnauthorizedException']

trace Должны ли журналы ошибок включать трассировки стека?
exceptionRenderer Экземпляр или имя класса рендерера, который следует использовать, или вызываемый фабричный метод, возвращающий экземпляр \Cake\Error\ExceptionRendererInterface. По умолчанию \Cake\Error\ExceptionRenderer

Тип

array<string, mixed>

`$errorHandler` protected

Экземпляр обработчика ошибок.

Тип

Cake\Error\ErrorHandler|null

© 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.Middleware.ErrorHandlerMiddleware.html

Класс ErrorHandlerMiddleware

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

getConfig() public

getConfigOrFail() public

getErrorHandler() protected

handleException() public

handleInternalError() protected

handleRedirect() public

process() public

setConfig() public

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

__construct() public

Параметры

Исключения

_configDelete() protected

Параметры

Возвращаемое значение

Исключения

_configRead() protected

Параметры

Возвращаемое значение

_configWrite() protected

Параметры

Возвращаемое значение

Исключения

configShallow() public

Параметры

Возвращаемое значение

getConfig() public

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

Параметры

Возвращаемое значение

getConfigOrFail() public

Параметры

Возвращаемое значение

Исключения

getErrorHandler() protected

Возвращаемое значение

handleException() public

Параметры

Возвращаемое значение

handleInternalError() protected

Возвращаемое значение

handleRedirect() public

Параметры

Возвращаемое значение

process() public

Параметры

Возвращаемое значение

setConfig() public

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

Параметры

Возвращаемое значение

Исключения

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

$errorHandler protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$errorHandler` protected