Class yii\web\ErrorAction

继承yii\web\ErrorAction » yii\base\Action » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/ErrorAction.php

ErrorAction 使用指定的视图显示应用程序错误.

要使用 ErrorAction, 你需要执行以下步骤:

首先, 在SiteController类(或者你喜欢的任何控制器)的actions()方法中声明一个 ErrorAction 类型的动作, 如下所示:

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

然后, 为此动作创建一个视图文件. 如果你的错误动作的路由是site/error, 则视图文件应该是views/site/error.php. 在此视图文件中, 以下变量是可用的:

  • $name: 错误名称.
  • $message: 错误消息.
  • $exception: 正在处理的异常.

最后, 如下配置应用程序errorHandler组件:

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

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此动作的控制器. yii\base\Action
$defaultMessage string 当异常消息包含敏感信息时要显示的消息. yii\web\ErrorAction
$defaultName string 无法确定异常名称时的错误名称. yii\web\ErrorAction
$id string 动作 ID. yii\base\Action
$layout string|false|null 要应用于此错误动作视图的布局的名称. yii\web\ErrorAction
$uniqueId string 整个应用程序中此动作的唯一 ID. 该属性是只读的. yii\base\Action
$view string 要渲染的视图文件. yii\web\ErrorAction

受保护的属性

隐藏继承的属性

属性类型描述定义在
$exception Exception 异常对象, 通常在 init() 方法调用中填充. yii\web\ErrorAction

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\Action
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getUniqueId() 返回整个应用程序中此动作的唯一 ID. yii\base\Action
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\web\ErrorAction
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
run() 运行该动作. yii\web\ErrorAction
runWithParams() 使用指定的参数运行此动作. yii\base\Action
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
afterRun() 在执行run()之后立即调用此方法. yii\base\Action
beforeRun() 在执行run()之前立即调用此方法. yii\base\Action
findException() ErrorHandler 组件获取异常. yii\web\ErrorAction
getExceptionCode() $exception 获取代码. yii\web\ErrorAction
getExceptionMessage() 仅返回 yii\base\UserException$exception 消息. yii\web\ErrorAction
getExceptionName() 返回异常名称, 后面是代码(如果存在). yii\web\ErrorAction
getViewRenderParams() 构建将传递给视图的参数数组. yii\web\ErrorAction
renderAjaxResponse() 构建表示异常的字符串. yii\web\ErrorAction
renderHtmlResponse() 渲染表示异常的视图. yii\web\ErrorAction

属性详情

$defaultMessage public 属性

当异常消息包含敏感信息时要显示的消息. 默认为"An internal server error occurred."(即: 发生内部服务器错误).

public string $defaultMessage null
$defaultName public 属性

无法确定异常名称时的错误名称. 默认为"Error".

public string $defaultName null
$exception protected 属性 (可用自版本: 2.0.11)

异常对象, 通常在 init() 方法调用中填充.

参见 [[findException()]] 了解获取异常的默认方式.

protected Exception $exception null
$layout public 属性 (可用自版本: 2.0.14)

要应用于此错误动作视图的布局的名称. 如果未设置, 则将使用控制器中配置的布局.

参见 yii\base\Controller::$layout.

public string|false|null $layout null
$view public 属性

要渲染的视图文件.

如果未设置, 则会采用 $id 的值.

这意味着, 如果你在SiteController中把此动作命名为error, 则此视图的名称将会是error, 而相应的视图文件将会是views/site/error.php.

public string $view null

方法详情

findException() protected 方法 (可用自版本: 2.0.11)

ErrorHandler 组件获取异常.

如果组件中没有异常, 则将动作视为不是从错误处理程序而是通过直接录音调用的, 因此将显示404 Not Found错误.

protected Exception findException ( )
getExceptionCode() protected 方法 (可用自版本: 2.0.11)

$exception 获取代码.

protected mixed getExceptionCode ( )
getExceptionMessage() protected 方法 (可用自版本: 2.0.11)

仅返回 yii\base\UserException$exception 消息.

对于其它情况, 将返回 $defaultMessage.

protected string getExceptionMessage ( )
getExceptionName() protected 方法 (可用自版本: 2.0.11)

返回异常名称, 后面是代码(如果存在).

protected string getExceptionName ( )
getViewRenderParams() protected 方法 (可用自版本: 2.0.11)

构建将传递给视图的参数数组.

protected array getViewRenderParams ( )
init() public 方法

初始化对象.

在使用给定的配置初始化对象之后, 在构造函数的末尾调用此方法.

public void init ( )
renderAjaxResponse() protected 方法 (可用自版本: 2.0.11)

构建表示异常的字符串.

通常用于生成对 AJAX 请求的响应.

protected string renderAjaxResponse ( )
renderHtmlResponse() protected 方法 (可用自版本: 2.0.11)

渲染表示异常的视图.

protected string renderHtmlResponse ( )
run() public 方法

运行该动作.

public string run ( )
return string

结果内容.