Class yii\web\ViewAction

所有类 | 属性 | 方法

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

ViewAction represents an action that displays a view according to a user-specified parameter.

By default, the view being displayed is specified via the view GET parameter. The name of the GET parameter can be customized via $viewParam.

Users specify a view in the format of path/to/view, which translates to the view name ViewPrefix/path/to/view where ViewPrefix is given by $viewPrefix. The view will then be rendered by the render() method of the currently active controller.

Note that the user-specified view name must start with a word character and can only contain word characters, forward slashes, dots and dashes.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$controller	yii\base\Controller\|yii\web\Controller\|yii\console\Controller	拥有此操作的控制器	yii\base\Action
$defaultView	string	The name of the default view when yii\web\ViewAction::$viewParam GET parameter is not provided by user.	yii\web\ViewAction
$id	string	动作的 ID	yii\base\Action
$layout	mixed	The name of the layout to be applied to the requested view.	yii\web\ViewAction
$uniqueId	string	整个应用程序中此操作的唯一 ID。	yii\base\Action
$viewParam	string	The name of the GET parameter that contains the requested view name.	yii\web\ViewAction
$viewPrefix	string	A string to be prefixed to the user-specified view name to form a complete view name.	yii\web\ViewAction

公共方法

隐藏继承的方法

方法	描述	被定义在
__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()	构造函数。	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()	返回整个应用程序中此动作的唯一 ID。	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\base\BaseObject
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\ViewAction
runWithParams()	使用指定的参数运行此动作。该方法主要由控制器调用。	yii\base\Action
trigger()	Triggers an event.	yii\base\Component

受保护的方法

隐藏继承的方法

方法	描述	被定义在
afterRun()	执行 `run()` 后立即调用此方法。您可以重写此方法以对动作运行执行后处理工作。	yii\base\Action
beforeRun()	在执行 `run()` 之前调用此方法。您可以重写此方法来为动作运行做准备工作。如果该方法返回 false，将取消该动作。	yii\base\Action
render()	Renders a view.	yii\web\ViewAction
resolveViewName()	Resolves the view name currently being requested.	yii\web\ViewAction

属性详情

$defaultView 公共属性

The name of the default view when yii\web\ViewAction::$viewParam GET parameter is not provided by user. Defaults to 'index'. This should be in the format of 'path/to/view', similar to that given in the GET parameter.

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

public string $defaultView = 'index'

$layout 公共属性

The name of the layout to be applied to the requested view. This will be assigned to yii\base\Controller::$layout before the view is rendered. Defaults to null, meaning the controller's layout will be used. If false, no layout will be applied.

public mixed $layout = null

$viewParam 公共属性

The name of the GET parameter that contains the requested view name.

public string $viewParam = 'view'

$viewPrefix 公共属性

A string to be prefixed to the user-specified view name to form a complete view name. For example, if a user requests for tutorial/chap1, the corresponding view name will be pages/tutorial/chap1, assuming the prefix is pages. The actual view file is determined by yii\base\View::findViewFile().

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

public string $viewPrefix = 'pages'

方法详情

render() 受保护方法

Renders a view.

protected string render($viewName)
$viewName	string	View name
return	string	Result of the rendering

resolveViewName() 受保护方法

Resolves the view name currently being requested.

protected string resolveViewName()
return	string	The resolved view name
throws	yii\web\NotFoundHttpException	if the specified view name is invalid

run() 公共方法

Runs the action.

This method displays the view requested by the user.

public void run()
throws	yii\web\NotFoundHttpException	if the view file cannot be found