Класс ErrorHandler

ErrorHandler предоставляет базовые обработку ошибок и исключений для вашего приложения. Он перехватывает и обрабатывает все необработанные исключения и ошибки. Отображает полезные ошибки фреймворка, когда debug > 1.

Неперехваченные исключения

Когда debug < 1, CakeException будет отображать ошибки 404 или 500. Если возникло неперехваченное исключение, и оно является типом, который ErrorHandler не знает, оно будет обработано как ошибка 500.

Реализация обработки исключений, специфичных для приложения

Вы можете реализовать обработку исключений, специфичных для приложения, несколькими способами. Каждый подход предоставляет различный уровень контроля над процессом обработки исключений.

Измените config/error.php и настройте пользовательскую обработку исключений.
Используйте параметр exceptionRenderer для вставки обработчика исключений. Это позволит сохранить существующую логику обработки, но переопределить логику отображения.

Создание собственного обработчика исключений

Это предоставляет вам полный контроль над процессом обработки исключений. Выбранный класс должен быть загружен в config/error.php и зарегистрирован как обработчик исключений по умолчанию.

Использование пользовательского рендерера с `exceptionRenderer`

Если вы не хотите контролировать обработку исключений, но хотите изменить способ отображения исключений, вы можете использовать параметр exceptionRenderer для выбора класса для отображения страниц исключений. По умолчанию используется Cake\Error\ExceptionRenderer. Ваш пользовательский класс рендерера исключений должен находиться в src/Error.

Ваш пользовательский рендерер должен ожидать исключение в своём конструкторе и реализовывать метод render. Отсутствие этого приведёт к дополнительным ошибкам.

Регистрация исключений

Используя встроенную обработку исключений, вы можете регистрировать все исключения, которые обрабатываются ErrorHandler, установив параметр log в значение true в config/error.php. Включение этого параметра позволит регистрировать каждое исключение в Log и настроенных логгерех.

PHP-ошибки

Обработчик ошибок также предоставляет встроенные функции для обработки PHP-ошибок (trigger_error). В режиме отладки ошибки будут выведены на экран с помощью отладчика. В режиме производства ошибки будут регистрироваться в Log. Вы можете контролировать, какие ошибки регистрировать, установив параметр errorLevel в config/error.php.

Регистрация ошибок

Когда ErrorHandler используется для обработки ошибок, вы можете включить регистрацию ошибок, установив параметр log в значение true. Это позволит регистрировать все ошибки в настроенных обработчиках логов.

Управление ошибками, которые регистрируются/отображаются

Вы можете контролировать, какие ошибки регистрируются/отображаются ErrorHandler, установив errorLevel. Установка этого параметра на одно или несколько значений констант E_* включит только указанные ошибки:

$options['errorLevel'] = E_ALL & ~E_NOTICE;

Это включит обработку всех ошибок, кроме Notice.

Cake\Error\BaseErrorHandler

Cake\Error\ErrorHandler

Пространство имен: Cake\Error
См.: \Cake\Error\ExceptionRenderer для получения дополнительной информации о настройке отображения исключений.
Расположение: Error/ErrorHandler.php

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

$_options protected

array
Параметры для использования в обработке ошибок.

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

__construct() public
Конструктор
_clearOutput() protected
Очистка буферов вывода для правильного отображения страниц ошибок.
_displayError() protected
Отображение ошибки.
_displayException() protected
Отображение тела ответа исключения.
_sendResponse() protected
Метод, который можно легко подменить при тестировании.

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

__construct()source public

__construct( array $options [] )

Конструктор

Параметры

массив $options необязательно []: Параметры обработки ошибок.

_clearOutput()source protected

_clearOutput( )

Очистка буферов вывода для правильного отображения страниц ошибок.

Легко подменяется при тестировании.

_displayError()source protected

_displayError( array $error , boolean $debug )

Отображение ошибки.

Шаблонный метод BaseErrorHandler.

Только при debug > 2 будет отображаться отформатированная ошибка.

Параметры

массив $error: Массив данных об ошибке.
булево значение $debug: Является ли приложение в режиме отладки.

_displayException()source protected

_displayException( Exception $exception )

Отображение тела ответа исключения.

Параметры

Исключение $exception: Исключение для отображения

Выбрасывает

Исключение
Когда выбранный рендерер исключений некорректен.

_sendResponse()source protected

_sendResponse( string|Cake\Network\Response $response )

Метод, который можно легко подменить при тестировании.

Параметры

строка|Cake\Network\Response $response: Сообщения или объект ответа.

Наследованные методы от Cake\Error\BaseErrorHandler

_getMessage()source protected

_getMessage( Exception $exception )

Генерирует отформатированное сообщение об ошибке

Параметры

Исключение $exception: Экземпляр исключения

Возвращает

Строка
Отформатированное сообщение

_logError()source protected

_logError( string $level , array $data )

Регистрация ошибки.

Параметры

строка $level: Имя уровня лога.
массив $data: Массив данных об ошибке.

Возвращает

Булево значение

_logException()source protected

_logException( Exception $exception )

Обработка регистрации исключения

Параметры

Исключение $exception: Экземпляр исключения.

Возвращает

Булево значение

_requestContext()source protected

_requestContext( Cake\Network\Request $request )

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

Параметры

Cake\Network\Request $request: Запрос для чтения.

Возвращает

Строка

_stop()source protected

_stop( integer $code )

Остановка процесса.

Реализовано в подклассах, которым это нужно.

Параметры

целое число $code: Код выхода.

handleError()source public

handleError( integer $code , string $description , string|null $file null , integer|null $line null , array|null $context null )

Установлен как обработчик ошибок по умолчанию CakePHP.

Используйте config/error.php для настройки или замены этого обработчика ошибок. Эта функция будет использовать Debugger для отображения ошибок, когда debug > 0. И будет регистрировать ошибки в Log, когда debug == 0.

Вы можете использовать параметр 'errorLevel' для установки типа обрабатываемых ошибок. С помощью параметра 'trace' можно включить следы ошибок.

Параметры

целое число $code: Код ошибки
строка $description: Описание ошибки
строка|null $file необязательно null: Файл, в котором произошла ошибка
целое число|null $line необязательно null: Строка, которая вызвала ошибку
массив|null $context необязательно null: Контекст

Возвращает

Булево значение
True, если ошибка была обработана

handleException()source public

handleException( Exception $exception )

Обработка необработанных исключений.

Использует шаблонный метод, предоставленный подклассами, для отображения ошибок соответствующим образом в среде.

Параметры

Исключение $exception: Экземпляр исключения.

Исключения

Исключение
При отсутствии класса рендеринга

См. также

http://php.net/manual/en/function.set-exception-handler.php

handleFatalError()source public

handleFatalError( integer $code , string $description , string $file , integer $line )

Отображение/Логирование критической ошибки.

Параметры

целое число $code: Код ошибки
строка $description: Описание ошибки
строка $file: Файл, в котором произошла ошибка
целое число $line: Строка, которая вызвала ошибку

Возвращает

boolean

increaseMemoryLimit()source public

increaseMemoryLimit( string $additionalKb )

Увеличивает установку ini PHP "memory_limit" на указанную величину в килобайтах

Параметры

строка $additionalKb: Число в килобайтах

mapErrorCode()source public static

mapErrorCode( integer $code )

Преобразование кода ошибки в слово Ошибки и местоположение логирования.

Параметры

целое число $code: Код ошибки для преобразования

Возвращает

массив
Массив слова ошибки и места логирования.

register()source public

register( )

Регистрация обработчиков ошибок и исключений.

wrapAndHandleException()source public

wrapAndHandleException( Exception|Error $exception )

Проверяет тип переданного исключения. Если это экземпляр Error, он оборачивает переданный объект в другой объект Exception для обеспечения обратной совместимости.

Параметры

Исключение|Ошибка $exception: Исключение для обработки

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

$_optionssource

protected массив

Параметры для использования в обработке ошибок.

[]

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Error.ErrorHandler.html

Класс ErrorHandler

Неперехваченные исключения

Реализация обработки исключений, специфичных для приложения

Создание собственного обработчика исключений

Использование пользовательского рендерера с exceptionRenderer

Регистрация исключений

PHP-ошибки

Регистрация ошибок

Управление ошибками, которые регистрируются/отображаются

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

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

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

__construct()source public

Параметры

_clearOutput()source protected

_displayError()source protected

Параметры

_displayException()source protected

Параметры

Выбрасывает

_sendResponse()source protected

Параметры

Наследованные методы от Cake\Error\BaseErrorHandler

_getMessage()source protected

Параметры

Возвращает

_logError()source protected

Параметры

Возвращает

_logException()source protected

Параметры

Возвращает

_requestContext()source protected

Параметры

Возвращает

_stop()source protected

Параметры

handleError()source public

Параметры

Возвращает

handleException()source public

Параметры

Исключения

См. также

handleFatalError()source public

Параметры

Возвращает

increaseMemoryLimit()source public

Параметры

mapErrorCode()source public static

Параметры

Возвращает

register()source public

wrapAndHandleException()source public

Параметры

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

$_optionssource

Использование пользовательского рендерера с `exceptionRenderer`