Spec-Zone.ru › CakePHP 3.8

Класс BaseErrorHandler

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

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

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

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

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

  • $_handled protected
    boolean
  • $_options protected
    array
    Параметры для обработки ошибок.

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

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

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

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

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

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

_displayError()source абстрактный protected

_displayError( array $error , boolean $debug )

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

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

Параметры

массив $error
Массив данных об ошибке.
логический $debug
Включён ли режим отладки.

_displayException()source абстрактный protected

_displayException( Exception $exception )

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

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

Параметры

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

_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\Http\ServerRequest $request )

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

Параметры

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

Возвращает

строка

_stop()source protected

_stop( integer $code )

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

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

Параметры

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

getMessageForException()source protected

getMessageForException( Exception $exception , boolean $isPrevious = false )

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

Параметры

Исключение $exception
Исключение, для которого генерируется сообщение.
логический $isPrevious необязательный false
False для исходного исключения, true для предыдущего

Возвращает

строка
Сообщение об ошибке

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
Экземпляр исключения.

Выбрасывает

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

См. также

https://secure.php.net/manual/en/function.set-exception-handler.php
END_OF_DOCUMENT_MARKER

handleFatalError()source public

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

Отобразить/залогировать критическую ошибку.

Параметры

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

Возвращает

boolean

increaseMemoryLimit()source public

increaseMemoryLimit( integer $additionalKb )

Увеличивает значение PHP ini параметра «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|Error $exception
Исключение для обработки

Подробности свойств

$_handledsource

protected boolean

false

$_optionssource

protected 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/3.8/class-Cake.Error.BaseErrorHandler.html

Spec-Zone.ru

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