Абстрактный класс yii\base\ErrorHandler
| Наследование | yii\base\ErrorHandler » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\console\ErrorHandler, yii\web\ErrorHandler |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/base/ErrorHandler.php |
ErrorHandler обрабатывает неперехваченные PHP ошибки и исключения.
ErrorHandler по умолчанию настроен как компонент приложения в yii\base\Application. Вы можете получить доступ к этому экземпляру через Yii::$app->errorHandler.
Для получения дополнительной информации и руководства по использованию ErrorHandler, см. статью руководства по обработке ошибок.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений | yii\base\Component |
| $discardExistingOutput | boolean | Удалить существующий вывод страницы перед отображением ошибки? | yii\base\ErrorHandler |
| $exception | Exception|null | Исключение, которое обрабатывается в данный момент. | yii\base\ErrorHandler |
| $memoryReserveSize | integer | Размер резервируемой памяти. | yii\base\ErrorHandler |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| clearOutput() | Удаляет весь вывод, выведенный до вызова этого метода. | yii\base\ErrorHandler |
| convertExceptionToError() | Преобразует исключение в ошибку PHP. | yii\base\ErrorHandler |
| convertExceptionToString() | Преобразует исключение в простую строку. | yii\base\ErrorHandler |
| detachBehavior() | Открепляет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Открепляет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| handleError() | Обрабатывает ошибки выполнения PHP, такие как предупреждения и сообщения. | yii\base\ErrorHandler |
| handleException() | Обрабатывает неперехваченные исключения PHP. | yii\base\ErrorHandler |
| handleFatalError() | Обрабатывает фатальные ошибки PHP. | yii\base\ErrorHandler |
| handleHhvmError() | Обрабатывает ошибки выполнения HHVM, такие как предупреждения и сообщения. | yii\base\ErrorHandler |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| logException() | Регистрирует данное исключение. | yii\base\ErrorHandler |
| off() | Открепляет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| register() | Регистрирует этот обработчик ошибок. | yii\base\ErrorHandler |
| trigger() | Срабатывает событие. | yii\base\Component |
| unregister() | Отменяет регистрацию этого обработчика ошибок, восстанавливая обработчики ошибок и исключений PHP. | yii\base\ErrorHandler |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| handleFallbackExceptionMessage() | Обрабатывает исключение, сгенерированное во время обработки исключения в handleException(). | yii\base\ErrorHandler |
| renderException() | Отображает исключение. | yii\base\ErrorHandler |
Подробное описание свойств
$discardExistingOutput public property
Удалять ли существующий вывод страницы перед отображением ошибки. По умолчанию значение true.
public boolean $discardExistingOutput = true
$exception public property
Исключение, которое обрабатывается в данный момент.
public Exception|null $exception = null
$memoryReserveSize public property
Размер резервируемой памяти. Часть памяти предварительно выделяется, чтобы при возникновении проблемы с недостатком памяти обработчик ошибок мог обработать ошибку с помощью этой зарезервированной памяти. Если вы установите это значение в 0, память не будет резервироваться. По умолчанию 256 КБ.
public integer $memoryReserveSize = 262144
Подробное описание методов
clearOutput() public method
Удаляет весь вывод, выведенный до вызова этого метода.
| public void clearOutput ( ) |
|---|
convertExceptionToError() public static method
Преобразует исключение в ошибку PHP.
Этот метод может быть использован для преобразования исключений внутри методов, таких как __toString() в ошибки PHP, так как исключения не могут быть сгенерированы внутри них.
| public static void convertExceptionToError ( $exception ) | ||
|---|---|---|
| $exception | Exception |
Исключение, которое необходимо преобразовать в ошибку PHP. |
convertExceptionToString() public static method
Преобразует исключение в простую строку.
| public static string convertExceptionToString ( $exception ) | ||
|---|---|---|
| $exception | Exception|\Error |
Преобразуемое исключение |
| return | string |
Строковое представление исключения. |
handleError() public method
Обрабатывает ошибки выполнения PHP, такие как предупреждения и сообщения.
Этот метод используется как обработчик ошибок PHP. Он просто сгенерирует исключение yii\base\ErrorException.
| public boolean handleError ( $code, $message, $file, $line ) | ||
|---|---|---|
| $code | integer |
Уровень поднятой ошибки. |
| $message | string |
Сообщение об ошибке. |
| $file | string |
Имя файла, в котором возникла ошибка. |
| $line | integer |
Номер строки, в которой произошла ошибка. |
| return | boolean |
Продолжает ли стандартная обработка ошибок. |
| throws | yii\base\ErrorException | |
handleException() public method
Обрабатывает неперехваченные PHP исключения.
Этот метод реализован как обработчик исключений PHP.
| public void handleException ( $exception ) | ||
|---|---|---|
| $exception | Exception |
Исключение, которое не было перехвачено |
handleFallbackExceptionMessage() protected method (доступно начиная с версии 2.0.11)
Обрабатывает исключение, сгенерированное при обработке исключения в handleException().
| protected void handleFallbackExceptionMessage ( $exception, $previousException ) | ||
|---|---|---|
| $exception | Exception|\Throwable |
Исключение, которое было сгенерировано во время основной обработки исключения. |
| $previousException | Exception |
Основное исключение, обработанное в handleException(). |
handleFatalError() public method
Обрабатывает фатальные ошибки PHP
| public void handleFatalError ( ) |
|---|
handleHhvmError() public method (доступно начиная с версии 2.0.6)
Обрабатывает ошибки выполнения HHVM, такие как предупреждения и сообщения.
Этот метод используется в качестве обработчика ошибок HHVM. Он сохранит исключение, которое будет использоваться обработчиком фатальных ошибок
| public boolean handleHhvmError ( $code, $message, $file, $line, $context, $backtrace ) | ||
|---|---|---|
| $code | integer |
Уровень поднятой ошибки. |
| $message | string |
Сообщение об ошибке. |
| $file | string |
Имя файла, в котором возникла ошибка. |
| $line | integer |
Номер строки, в которой произошла ошибка. |
| $context | mixed | |
| $backtrace | mixed |
Трек ошибки |
| return | boolean |
Продолжает ли стандартная обработка ошибок. |
| throws | yii\base\ErrorException | |
logException() public method (доступно начиная с версии 2.0.3)
Записывает указанное исключение в журнал
| public void logException ( $exception ) | ||
|---|---|---|
| $exception | Exception |
Исключение, которое нужно записать в журнал |
register() public method
Регистрирует этот обработчик ошибок
| public void register ( ) |
|---|
renderException() protected abstract method
Отображает исключение.
| protected abstract void renderException ( $exception ) | ||
|---|---|---|
| $exception | Exception |
Исключение, которое нужно отобразить. |
unregister() public method
Отменяет регистрацию этого обработчика ошибок, восстанавливая обработчики ошибок и исключений PHP.
| public void unregister ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-errorhandler.html