Класс yii\web\ErrorHandler
| Наследование | yii\web\ErrorHandler » yii\base\ErrorHandler » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/ErrorHandler.php |
ErrorHandler обрабатывает неперехваченные PHP ошибки и исключения.
ErrorHandler отображает эти ошибки с помощью соответствующих представлений, основанных на типе ошибок и режиме работы приложения.
ErrorHandler по умолчанию настроен как компонент приложения в yii\base\Application. Вы можете получить доступ к этому экземпляру через Yii::$app->errorHandler.
Для получения более подробной информации и руководства по использованию ErrorHandler, см. статью руководства по обработке ошибок.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $callStackItemView | string | Путь к файлу представления для рендеринга элементов стека вызовов исключений и ошибок. | yii\web\ErrorHandler |
| $discardExistingOutput | boolean | Определяет, нужно ли отбрасывать существующий вывод страницы перед отображением ошибки. | yii\base\ErrorHandler |
| $displayVars | array | Список предопределённых PHP переменных, которые должны быть отображены на странице ошибки. | yii\web\ErrorHandler |
| $errorAction | string | Маршрут (например, site/error) к действию контроллера, который будет использоваться для отображения внешних ошибок. | yii\web\ErrorHandler |
| $errorView | string | Путь к файлу представления для рендеринга исключений без информации о стеке вызовов. | yii\web\ErrorHandler |
| $exception | Exception|null | Исключение, которое в данный момент обрабатывается. | yii\base\ErrorHandler |
| $exceptionView | string | Путь к файлу представления для рендеринга исключений. | yii\web\ErrorHandler |
| $maxSourceLines | integer | Максимальное количество строк исходного кода для отображения. | yii\web\ErrorHandler |
| $maxTraceSourceLines | integer | Максимальное количество строк исходного кода для отображения стека вызовов. | yii\web\ErrorHandler |
| $memoryReserveSize | integer | Размер зарезервированной памяти. | yii\base\ErrorHandler |
| $previousExceptionView | string | Путь к файлу представления для рендеринга предыдущих исключений. | yii\web\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 |
| addTypeLinks() | Добавляет информационные ссылки к указанному типу/классу PHP. | yii\web\ErrorHandler |
| argumentsToString() | Преобразует массив аргументов в строковое представление | yii\web\ErrorHandler |
| 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 |
| createFrameworkVersionLink() | Создаёт строку, содержащую HTML-ссылку, которая ссылается на страницу с текущей версией фреймворка и текстом номера версии. | yii\web\ErrorHandler |
| createHttpStatusLink() | Создаёт HTML, содержащий ссылку на страницу с информацией об указанном коде HTTP-статуса. | yii\web\ErrorHandler |
| createServerInformationLink() | Создаёт строку, содержащую HTML-ссылку, которая ссылается на главную страницу определённого программного обеспечения веб-сервера и его полное имя. | yii\web\ErrorHandler |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getExceptionName() | Возвращает удобочитаемое имя исключения | yii\web\ErrorHandler |
| 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 |
| htmlEncode() | Преобразует специальные символы в HTML-сущности. | yii\web\ErrorHandler |
| init() | Инициализирует объект. | yii\base\Object |
| isCoreFile() | Определяет, принадлежит ли данное имя файла фреймворку. | yii\web\ErrorHandler |
| logException() | Записывает указанное исключение в журнал | yii\base\ErrorHandler |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| register() | Регистрирует этот обработчик ошибок | yii\base\ErrorHandler |
| renderCallStack() | Отображает стек вызовов. | yii\web\ErrorHandler |
| renderCallStackItem() | Отображает один элемент стека вызовов. | yii\web\ErrorHandler |
| renderFile() | Отображает файл представления как PHP-скрипт. | yii\web\ErrorHandler |
| renderPreviousExceptions() | Отображает стек предыдущих исключений для данного исключения. | yii\web\ErrorHandler |
| renderRequest() | Отображает глобальные переменные запроса. | yii\web\ErrorHandler |
| trigger() | Вызывает событие. | yii\base\Component |
| unregister() | Отменяет регистрацию этого обработчика ошибок, восстанавливая обработчики ошибок и исключений PHP. | yii\base\ErrorHandler |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| convertExceptionToArray() | Преобразует исключение в массив. | yii\web\ErrorHandler |
| getTypeUrl() | Возвращает URL информационной ссылки для заданного типа/класса PHP. | yii\web\ErrorHandler |
| handleFallbackExceptionMessage() | Обрабатывает исключение, брошенное во время обработки исключения в handleException(). | yii\base\ErrorHandler |
| renderException() | Отображает исключение. | yii\web\ErrorHandler |
| shouldRenderSimpleHtml() | yii\web\ErrorHandler |
Свойства
$callStackItemView общедоступное свойство
Путь к файлу представления для рендеринга элементов стека вызовов исключений и ошибок.
public string $callStackItemView = '@yii/views/errorHandler/callStackItem.php'
$displayVars общедоступное свойство (доступно начиная с версии 2.0.7)
Список предопределенных переменных PHP, которые должны отображаться на странице ошибки. Обратите внимание, что переменная должна быть доступна через $GLOBALS. В противном случае она не будет отображаться. По умолчанию ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION'].
См. также renderRequest().
public array $displayVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']
$errorAction общедоступное свойство
Маршрут (например, site/error) к действию контроллера, который будет использоваться для отображения внешних ошибок. Внутри действия можно получить информацию об ошибке, используя Yii::$app->errorHandler->exception. Это свойство по умолчанию равно null, что означает, что ErrorHandler будет обрабатывать отображение ошибки.
public string $errorAction = null
$errorView общедоступное свойство
Путь к файлу представления для рендеринга исключений без информации о стеке вызовов.
public string $errorView = '@yii/views/errorHandler/error.php'
$exceptionView общедоступное свойство
Путь к файлу представления для рендеринга исключений.
public string $exceptionView = '@yii/views/errorHandler/exception.php'
$maxSourceLines общедоступное свойство
Максимальное количество строк исходного кода для отображения. По умолчанию 19.
public integer $maxSourceLines = 19
$maxTraceSourceLines общедоступное свойство
Максимальное количество строк исходного кода трассировки для отображения. По умолчанию 13.
public integer $maxTraceSourceLines = 13
$previousExceptionView общедоступное свойство
Путь к файлу представления для рендеринга предыдущих исключений.
public string $previousExceptionView = '@yii/views/errorHandler/previousException.php'
Подробное описание методов
addTypeLinks() public method
Добавляет информационные ссылки для заданного типа/класса PHP.
| public string addTypeLinks ( $code ) | ||
|---|---|---|
| $code | string |
Имя типа/класса для добавления ссылок. |
| return | string |
Имя типа/класса с добавленными HTML-ссылками. |
argumentsToString() public method
Преобразует массив аргументов в строковое представление.
| public string argumentsToString ( $args ) | ||
|---|---|---|
| $args | array |
Массив аргументов для преобразования. |
| return | string |
Строковое представление массива аргументов. |
convertExceptionToArray() protected method
Преобразует исключение в массив.
| protected array convertExceptionToArray ( $exception ) | ||
|---|---|---|
| $exception | Exception|\Error |
Преобразуемое исключение. |
| return | array |
Массивовое представление исключения. |
createFrameworkVersionLink() public method
Создаёт строку, содержащую HTML-ссылку на страницу с текущей версией фреймворка и текстом номера версии.
| public string createFrameworkVersionLink ( ) | ||
|---|---|---|
| return | string |
Гиперссылка на информацию о версии фреймворка. |
createHttpStatusLink() public method
Создаёт HTML-контент со ссылкой на страницу с информацией о заданном HTTP-коде состояния.
| public string createHttpStatusLink ( $statusCode, $statusDescription ) | ||
|---|---|---|
| $statusCode | integer |
Используется для создания ссылки на информацию. |
| $statusDescription | string |
Описание, отображаемое после кода состояния. |
| return | string |
Сгенерированный HTML с информацией о HTTP-коде состояния. |
createServerInformationLink() public method
Создаёт строку, содержащую HTML-ссылку на главную страницу определённого веб-сервера и его полное название.
| public string createServerInformationLink ( ) | ||
|---|---|---|
| return | string |
Гиперссылка на информацию о программном обеспечении сервера. |
getExceptionName() public method
Возвращает удобочитаемое имя исключения.
| public string getExceptionName ( $exception ) | ||
|---|---|---|
| $exception | Exception | |
| return | string |
Удобочитаемое имя исключения или null, если его невозможно определить. |
getTypeUrl() protected method
Возвращает URL информационной ссылки для заданного типа/класса PHP.
См. также addTypeLinks().
| protected string|null getTypeUrl ( $class, $method ) | ||
|---|---|---|
| $class | string |
Имя типа или класса. |
| $method | string|null |
Имя метода. |
| return | string|null |
URL информационной ссылки. |
htmlEncode() public method
Преобразует специальные символы в HTML-сущности.
| public string htmlEncode ( $text ) | ||
|---|---|---|
| $text | string |
Строка для кодирования. |
| return | string |
Закодированная исходная строка. |
isCoreFile() public method
Определяет, относится ли данное имя файла к фреймворку.
| public boolean isCoreFile ( $file ) | ||
|---|---|---|
| $file | string |
Имя файла для проверки. |
| return | boolean |
Принадлежит ли данное имя файла фреймворку. |
renderCallStack() public method (доступно начиная с версии 2.0.12)
Отображает стек вызовов.
| public string renderCallStack ( $exception ) | ||
|---|---|---|
| $exception | Exception|\ParseError |
Исключение, для получения стека вызовов. |
| return | string |
HTML-контент отрисованного стека вызовов. |
renderCallStackItem() public method
Отображает один элемент стека вызовов.
| public string renderCallStackItem ( $file, $line, $class, $method, $args, $index ) | ||
|---|---|---|
| $file | string|null |
Имя файла, где произошёл вызов. |
| $line | integer|null |
Номер строки, где произошёл вызов. |
| $class | string|null |
Имя вызываемого класса. |
| $method | string|null |
Имя вызываемой функции/метода. |
| $args | array |
Массив аргументов метода. |
| $index | integer |
Номер элемента стека вызовов. |
| return | string |
HTML-контент отрисованного элемента стека вызовов. |
renderException() protected method
Отображает исключение.
| protected void renderException ( $exception ) | ||
|---|---|---|
| $exception | Exception|\Error |
Исключение для отображения. |
renderFile() public method
Отображает файл представления как PHP-скрипт.
| public string renderFile ( $_file_, $_params_ ) | ||
|---|---|---|
| $_file_ | string |
Файл представления. |
| $_params_ | array |
Параметры (парные имя-значение), которые будут извлечены и доступны в файле представления. |
| return | string |
Результат рендеринга. |
renderPreviousExceptions() public method
Отображает стек предыдущих исключений для данного исключения.
| public string renderPreviousExceptions ( $exception ) | ||
|---|---|---|
| $exception | Exception |
Исключение, предшественники которого должны быть отображены. |
| return | string |
HTML-контент отображённых предшествующих исключений. Пустая строка, если их нет. |
renderRequest() public method
Отображает глобальные переменные запроса.
Список глобальных переменных определён в $displayVars.
См. также $displayVars.
| public string renderRequest ( ) | ||
|---|---|---|
| return | string |
Результат отображения |
shouldRenderSimpleHtml() protected method (available since version 2.0.12)
| protected boolean shouldRenderSimpleHtml ( ) | ||
|---|---|---|
| return | boolean |
Если должно быть отображено простое HTML |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-errorhandler.html
