Class yii\web\ViewAction

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

ViewAction 表示根据用户指定的参数显示视图的动作.

默认情况下, 正在显示的视图是通过view GET 参数指定的. 可以通过 $viewParam 自定义 GET 参数的名称.

用户以path/to/view的格式指定视图, 该视图会转换为视图名称ViewPrefix/path/to/view, 其中ViewPrefix$viewPrefix 给出的.

然后, 将通过当前活动控制器的 render() 方法渲染该视图.

Note: 用户指定的视图名称必须以单词字符开头, 并且只能包含单词字符, 正斜杠|, 点.和破折号-.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此动作的控制器. yii\base\Action
$defaultView string 用户未提供 yii\web\ViewAction::$viewParam GET 参数时的默认视图名称. yii\web\ViewAction
$id string 动作 ID. yii\base\Action
$layout mixed 要应用于请求的视图的布局的名称. yii\web\ViewAction
$uniqueId string 整个应用程序中此动作的唯一 ID. 该属性是只读的. yii\base\Action
$viewParam string 包含请求的视图名称的 GET 参数的名称. yii\web\ViewAction
$viewPrefix string 在用户指定的视图名称前添加前缀以形成完整的视图名称的字符串. yii\web\ViewAction

公共方法

隐藏继承的方法

方法描述定义在
__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\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
run() 运行该操作. yii\web\ViewAction
runWithParams() 使用指定的参数运行此动作. yii\base\Action
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
afterRun() 在执行run()之后立即调用此方法. yii\base\Action
beforeRun() 在执行run()之前立即调用此方法. yii\base\Action
render() 渲染视图. yii\web\ViewAction
resolveViewName() 解析当前正在请求的视图名称. yii\web\ViewAction

属性详情

$defaultView public 属性

用户未提供 yii\web\ViewAction::$viewParam GET 参数时的默认视图名称. 默认为index.

这应该是path/to/view的格式, 类似于 GET 参数中给出的格式.

参见 yii\web\ViewAction::$viewPrefix.

public string $defaultView 'index'
$layout public 属性

要应用于请求的视图的布局的名称.

在渲染视图之前, 这将被分配给 yii\base\Controller::$layout.

默认为null, 表示将使用控制器的布局.

如果为false, 则不会应用任何布局.

public mixed $layout null
$viewParam public 属性

包含请求的视图名称的 GET 参数的名称.

public string $viewParam 'view'
$viewPrefix public 属性

在用户指定的视图名称前添加前缀以形成完整的视图名称的字符串.

例如, 如果用户请求tutorial/chap1, 则假定前缀为pages, 则相应的视图名称将是pages/tutorial/chap1.

实际的视图文件由 yii\base\View::findViewFile() 确定.

参见 yii\base\View::findViewFile().

public string $viewPrefix 'pages'

方法详情

render() protected 方法

渲染视图.

protected string render ( $viewName )
$viewName string

视图名称.

return string

渲染的结果.

resolveViewName() protected 方法

解析当前正在请求的视图名称.

protected string resolveViewName ( )
return string

已解析的视图名称.

throws yii\web\NotFoundHttpException

如果指定的视图名称无效.

run() public 方法

运行该操作.

此方法显示用户请求的视图.

public void run ( )
throws yii\web\NotFoundHttpException

如果找不到视图文件.