Class yii\web\ErrorAction
Inheritance | yii\web\ErrorAction » yii\base\Action » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/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',
]
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component |
$controller | yii\base\Controller|yii\web\Controller|yii\console\Controller | The controller that owns this action | yii\base\Action |
$defaultMessage | string | The message to be displayed when the exception message contains sensitive information. | yii\web\ErrorAction |
$defaultName | string | The name of the error when the exception name cannot be determined. | yii\web\ErrorAction |
$id | string | ID of the action | yii\base\Action |
$layout | string|false|null | The name of the layout to be applied to this error action view. | yii\web\ErrorAction |
$uniqueId | string | The unique ID of this action among the whole application. This property is read-only. | yii\base\Action |
$view | string | The view file to be rendered. | yii\web\ErrorAction |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$exception | Exception | The exception object, normally is filled on init() method call. | yii\web\ErrorAction |
Public Methods
Method | Description | Defined By |
---|---|---|
__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 |
__construct() | Constructor. | yii\base\Action |
__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() | 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 |
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. | yii\web\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. | yii\web\ErrorAction |
runWithParams() | Runs this action with the specified parameters. | yii\base\Action |
trigger() | Triggers an event. | yii\base\Component |
Protected Methods
Method | Description | Defined By |
---|---|---|
afterRun() | This method is called right after run() is executed. |
yii\base\Action |
beforeRun() | This method is called right before run() is executed. |
yii\base\Action |
findException() | Gets exception from the ErrorHandler component. | yii\web\ErrorAction |
getExceptionCode() | Gets the code from the $exception. | yii\web\ErrorAction |
getExceptionMessage() | Returns the $exception message for yii\base\UserException only. | yii\web\ErrorAction |
getExceptionName() | Returns the exception name, followed by the code (if present). | yii\web\ErrorAction |
getViewRenderParams() | Builds array of parameters that will be passed to the view. | yii\web\ErrorAction |
renderAjaxResponse() | Builds string that represents the exception. | yii\web\ErrorAction |
renderHtmlResponse() | Renders a view that represents the exception. | yii\web\ErrorAction |
Property Details
The message to be displayed when the exception message contains sensitive information. Defaults to "An internal server error occurred.".
The name of the error when the exception name cannot be determined. Defaults to "Error".
The exception object, normally is filled on init() method call.
See also [[findException()]] to know default way of obtaining exception.
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.
See also yii\base\Controller::$layout.
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
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.
protected Exception findException ( ) |
Gets the code from the $exception.
protected mixed getExceptionCode ( ) |
Returns the $exception message for yii\base\UserException only.
For other cases $defaultMessage will be returned.
protected string getExceptionMessage ( ) |
Returns the exception name, followed by the code (if present).
protected string getExceptionName ( ) |
Builds array of parameters that will be passed to the view.
protected array getViewRenderParams ( ) |
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
Builds string that represents the exception.
Normally used to generate a response to AJAX request.
protected string renderAjaxResponse ( ) |
Renders a view that represents the exception.
protected string renderHtmlResponse ( ) |
Runs the action.
public string run ( ) | ||
return | string | Result content |
---|
Signup or Login in order to comment.