ErrorAction

API reference › yii › web › ErrorAction

class	`yii\web\ErrorAction`
Extends	`yii\base\Action` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/web/ErrorAction.php`

ErrorAction displays application errors using a specified view.

To use ErrorAction, you need to do the following steps:

First, declare an action of ErrorAction type in the actions() method of your SiteController class (or whatever controller you prefer), like the following:

public function actions()
{
    return [
        'error' => ['class' => 'yii\web\ErrorAction'],
    ];
}

Then, create a view file for this action. If the route of your error action is site/error, then the view file should be views/site/error.php. In this view file, the following variables are available:

$name: the error name
$message: the error message
$exception: the exception being handled

Finally, configure the “errorHandler” application component as follows,

'errorHandler' => [
    'errorAction' => 'site/error',
]

Not standalone-compatible: this action requires a hosting controller because rendering, layout resolution, and view aliases are performed through the controller. Register it via Controller::actions() rather than Module::$actionMap.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$controller`	`yii\base\T\|null`	The controller that owns this action, or `null` when the action runs standalone. via `Module::$actionMap` Default: `null`.	`yii\base\Action`
`$defaultMessage`	`string`	The message to be displayed when the exception message contains sensitive information. Default: `null`.	`ErrorAction`
`$defaultName`	`string`	The name of the error when the exception name cannot be determined. Default: `null`.	`ErrorAction`
`$id`	`string\|null`	ID of the action; `null` between construction and dispatcher post-assignment for standalone actions resolved through `Module::$actionMap` or `Module::$actionNamespace`. Default: `null`.	`yii\base\Action`
`$layout`	`string\|null\|false`	The name of the layout to be applied to this error action view. Default: `null`. Available since 2.0.14.	`ErrorAction`
`$module`	`yii\base\Module\|null`	The owning module, or `null` if neither a module nor a controller is attached. Available since 22.0.	`yii\base\Action`
`$uniqueId` read-only	`string`	The unique ID of this action among the whole application.	`yii\base\Action`
`$view`	`string\|null`	The view file to be rendered. Default: `null`.	`ErrorAction`
`$exception` protected	`Throwable`	The exception object, normally is filled on `init()` method call. Default: `null`. Available since 2.0.11.	`ErrorAction`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\Action`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getModule()`	Returns the module that owns this action when invoked standalone.	`yii\base\Action`
`getUniqueId()`	Returns the unique ID of this action among the whole application.	`yii\base\Action`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`ErrorAction`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`run()`	Runs the action.	`ErrorAction`
`runWithParams()`	Runs this action with the specified parameters.	`yii\base\Action`
`setModule()`	Sets the module that owns this action when invoked standalone.	`yii\base\Action`
`trigger()`	Triggers an event.	`yii\base\Component`
`afterRun()` protected	This method is called right after `run()` is executed.	`yii\base\Action`
`beforeRun()` protected	This method is called right before `run()` is executed.	`yii\base\Action`
`findException()` protected	Gets exception from the ErrorHandler component.	`ErrorAction`
`getExceptionCode()` protected	Gets the code from the `$exception`.	`ErrorAction`
`getExceptionMessage()` protected	Returns the `$exception` message for `UserException` only.	`ErrorAction`
`getExceptionName()` protected	Returns the exception name, followed by the code (if present).	`ErrorAction`
`getViewRenderParams()` protected	Builds array of parameters that will be passed to the view.	`ErrorAction`
`renderAjaxResponse()` protected	Builds string that represents the exception.	`ErrorAction`
`renderHtmlResponse()` protected	Renders a view that represents the exception.	`ErrorAction`
`resolveStandaloneParams()` protected	Resolves typed parameters of `run()` when the action is invoked without a hosting controller.	`yii\base\Action`

Property details

$defaultMessage

public string $defaultMessage = null

The message to be displayed when the exception message contains sensitive information.

Defaults to “An internal server error occurred.”.

$defaultName

public string $defaultName = null

The name of the error when the exception name cannot be determined.

Defaults to “Error”.

$layout

public string|null|false $layout = null

The name of the layout to be applied to this error action view.

If not set, the layout configured in the controller will be used.

Since

2.0.14

$view

public string|null $view = null

The view file to be rendered.

If not set, it will take the value of $id. That means, if you name the action as “error” in “SiteController”, then the view name would be “error”, and the corresponding view file would be “views/site/error.php”.

Method details

init()

public function init(): mixed

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

Returns

mixed

run()

public function run(): string

Runs the action.

Returns

string: Result content

findException()

protected function findException(): Throwable

Gets exception from the ErrorHandler component.

In case there is no exception in the component, treat as the action has been invoked not from error handler, but by direct route, so ‘404 Not Found’ error will be displayed.

Returns

Throwable

Since

2.0.11

getExceptionCode()

protected function getExceptionCode(): mixed

Gets the code from the $exception.

Returns

mixed

Since

2.0.11

getExceptionMessage()

protected function getExceptionMessage(): string

Returns the $exception message for UserException only.

For other cases $defaultMessage will be returned.

Returns

string

Since

2.0.11

getExceptionName()

protected function getExceptionName(): string

Returns the exception name, followed by the code (if present).

Returns

string

Since

2.0.11

getViewRenderParams()

protected function getViewRenderParams(): array

Builds array of parameters that will be passed to the view.

Returns

array

Since

2.0.11

renderAjaxResponse()

protected function renderAjaxResponse(): string

Builds string that represents the exception.

Normally used to generate a response to AJAX request.

Returns

string

Since

2.0.11

renderHtmlResponse()

protected function renderHtmlResponse(): string

Renders a view that represents the exception.

Returns

string

Since

2.0.11