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.
Exibir arquivo
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 Details
render()
protected method
resolveViewName()
protected method
Resolves the view name currently being requested.
This method displays the view requested by the user.
Property Details
$defaultView public_oe 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.
$layout public_oe 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.
$viewParam public_oe property
the name of the GET parameter that contains the requested view name.
$viewPrefix public_oe 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()]].