Класс yii\web\ViewAction
| Наследование | yii\web\ViewAction » yii\base\Action » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/ViewAction.php |
ViewAction представляет действие, отображающее представление в соответствии с параметром, указанным пользователем.
По умолчанию, отображаемое представление задаётся через параметр view GET. Имя параметра GET можно настроить с помощью $viewParam.
Пользователь указывает представление в формате path/to/view, что переводится в имя представления ViewPrefix/path/to/view, где ViewPrefix задаётся с помощью $viewPrefix. Затем представление будет отображено методом render() текущего активного контроллера.
Обратите внимание, что имя представления, указанное пользователем, должно начинаться с символа слова и может содержать только символы слова, обратные слэши, точки и тире.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, прикреплённых к данному компоненту | yii\base\Component |
| $controller | yii\base\Controller|yii\web\Controller | Контроллер, которому принадлежит это действие | yii\base\Action |
| $defaultView | строка | Имя представления по умолчанию, когда пользователь не предоставляет параметр yii\web\ViewAction::$viewParam в GET. | yii\web\ViewAction |
| $id | строка | Идентификатор действия | yii\base\Action |
| $layout | смешанный | Имя макета, который будет применён к запрашиваемому представлению. | yii\web\ViewAction |
| $uniqueId | строка | Уникальный идентификатор этого действия во всём приложении. | yii\base\Action |
| $viewParam | строка | Имя параметра GET, содержащего имя запрашиваемого представления. | yii\web\ViewAction |
| $viewPrefix | строка | Строка, которая будет добавлены в качестве префикса к имени представления, указанному пользователем, для формирования полного имени представления. | yii\web\ViewAction |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Action |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Открепляет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Открепляет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все прикреплённые к этому компоненту поведения. | yii\base\Component |
| getUniqueId() | Возвращает уникальный идентификатор этого действия во всём приложении. | yii\base\Action |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикреплённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| 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 открытое свойство
Имя по умолчанию представления, когда параметр GET yii\web\ViewAction::$viewParam не предоставлен пользователем. По умолчанию «index». Оно должно быть в формате «путь/к/представлению», аналогично тому, что указано в параметре GET.
См. также yii\web\ViewAction::$viewPrefix.
public string $defaultView = 'index'
$layout общедоступное свойство
Имя макета, который необходимо применить к запрошенному представлению. Оно будет назначено свойству yii\base\Controller::$layout перед отрисовкой представления. По умолчанию null, что означает использование макета контроллера. Если false, макет не будет применён.
public mixed $layout = null
$viewParam общедоступное свойство
Имя параметра GET, содержащего имя запрошенного представления.
public string $viewParam = 'view'
$viewPrefix общедоступное свойство
Строка, которая будет добавлена в качестве префикса к имени представления, указанному пользователем, для формирования полного имени представления. Например, если пользователь запросит tutorial/chap1, соответствующее имя представления будет pages/tutorial/chap1, предполагая, что префикс равен pages. Фактический файл представления определяется методом yii\base\View::findViewFile().
См. также yii\base\View::findViewFile().
public string $viewPrefix = 'pages'
Подробное описание методов
render() защищённый метод
Отображает представление
| защищённый строка render ( $viewName ) | ||
|---|---|---|
| $viewName | строка |
Имя представления |
| return | строка |
Результат рендеринга |
resolveViewName() защищённый метод
Разрешает имя представления, которое в настоящее время запрашивается.
| защищённый строка resolveViewName ( ) | ||
|---|---|---|
| return | строка |
Разрешенное имя представления |
| throws | yii\web\NotFoundHttpException |
если указанное имя представления недопустимо |
run() общедоступный метод
Выполняет действие.
Этот метод отображает представление, запрошенное пользователем.
| общедоступный void run ( ) | ||
|---|---|---|
| throws | yii\web\NotFoundHttpException |
если файл представления не найден |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-viewaction.html
