Spec-Zone.ru › CakePHP 3.3

Класс BaseErrorHandler

Базовый обработчик ошибок, предоставляющий логику, общую для обработчиков ошибок/исключений CLI и веб-приложений.

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

Прямые подклассы

  • Cake\Console\ConsoleErrorHandler
  • Cake\Error\ErrorHandler
Абстрактный
Пространство имен: Cake\Error
Расположение: Error/BaseErrorHandler.php

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

  • _displayError() абстрактный защищённый
    Отображение сообщения об ошибке специфичным для среды способом.
  • _displayException() абстрактный защищённый
    Отображение исключения специфичным для среды способом.
  • _getMessage() защищённый
    Генерирует отформатированное сообщение об ошибке
  • _logError() защищённый
    Запись ошибки в журнал.
  • _logException() защищённый
    Обработка записи исключений в журнал
  • _requestContext() защищённый
    Получение контекста запроса для отслеживания ошибки/исключения.
  • _stop() защищённый
    Остановка процесса.
  • handleError() публичный
    Устанавливается по умолчанию как обработчик ошибок CakePHP.
  • handleException() публичный
    Обработка необработанных исключений.
  • handleFatalError() публичный
    Отображение/запись критической ошибки в журнал.
  • increaseMemoryLimit() публичный

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

  • mapErrorCode() публичный статический
    Сопоставление кода ошибки с текстом ошибки и местоположением записи в журнал.
  • register() публичный
    Регистрация обработчиков ошибок и исключений.
  • wrapAndHandleException() публичный

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

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

_displayError()source абстрактный защищённый

_displayError( array $error , boolean $debug )

Отображение сообщения об ошибке специфичным для среды способом.

Подклассы должны реализовать этот метод для отображения ошибки так, как это необходимо для среды, в которой они работают.

Параметры

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

_displayException()source абстрактный защищённый

_displayException( Exception $exception )

Отображение исключения специфичным для среды способом.

Подклассы должны реализовать этот метод для отображения необработанного исключения так, как это необходимо для среды, в которой они работают.

Параметры

Исключение $exception
Необработанное исключение.

_getMessage()source защищённый

_getMessage( Exception $exception )

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

Параметры

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

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

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

_logError()source защищённый

_logError( string $level , array $data )

Запись ошибки в журнал.

Параметры

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

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

булево

_logException()source защищённый

_logException( Exception $exception )

Обработка записи исключений в журнал

Параметры

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

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

булево

_requestContext()source защищённый

_requestContext( Cake\Network\Request $request )

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

Параметры

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

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

строка

_stop()source защищённый

_stop( integer $code )

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

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

Параметры

целое $code
Код завершения.

handleError()source публичный

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

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

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

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

Параметры

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

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

булево
Истина, если ошибка была обработана

handleException()source публичный

handleException( Exception $exception )

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

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

Параметры

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

Исключения

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

См. также

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

handleFatalError()source публичный

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

Отображение/запись критической ошибки в журнал.

Параметры

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

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

булево

increaseMemoryLimit()source публичный

increaseMemoryLimit( string $additionalKb )

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

Параметры

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

mapErrorCode()source публичный статический

mapErrorCode( integer $code )

Сопоставление кода ошибки с текстом ошибки и местоположением записи в журнал.

Параметры

целое $code
Код ошибки для сопоставления

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

массив
Массив текста ошибки и местоположения записи в журнал.
END_OF_DOCUMENT_MARKER

register()source public

register( )

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

wrapAndHandleException()source public

wrapAndHandleException( Exception|Error $exception )

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

Параметры

Exception|Error $exception
Исключение для обработки

© 2005–2017 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/3.3/class-Cake.Error.BaseErrorHandler.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API