PHP Class yii\web\ViewAction

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 [[\yii\base\Controller::render()|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.

Since: 2.0

Author: Alexander Makarov ([email protected])

Author: Qiang Xue ([email protected])

Inheritance: extends yii\base\Action

Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$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.
$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.
$viewParam		the name of the GET parameter that contains the requested view name.
$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()]].

Public Methods

Method	Description
run ( )	Runs the action.

Protected Methods

Method	Description
render ( string $viewName ) : string	Renders a view
resolveViewName ( ) : string	Resolves the view name currently being requested.

Method Details

render() protected method

Renders a view

protected render ( string $viewName ) : string
$viewName	string	view name
return	string	result of the rendering

resolveViewName() protected method

Resolves the view name currently being requested.

protected resolveViewName ( ) : string
return	string	the resolved view name

run() public method

This method displays the view requested by the user.

public run ( )

Property Details

$defaultView public property

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.

See also: yii\web\ViewAction::$viewPrefix

public $defaultView

$layout public property

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 $layout

$viewParam public property

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

public $viewParam

$viewPrefix public property

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()]].