Класс yii\rest\ViewAction

Все классы | Свойства | Методы

Наследование	yii\rest\ViewAction » yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/rest/ViewAction.php

ViewAction реализует конечную точку API для возвращения подробной информации о модели.

Для более подробной информации и использования ViewAction, см. статью руководства по контроллерам rest.

Публичные свойства

Свойство	Тип	Описание	Определено в
$behaviors	yii\base\Behavior[]	Список прикрепленных к этому компоненту поведений	yii\base\Component
$checkAccess	callable	PHP-вызов, который будет вызван при выполнении действия для определения, имеет ли текущий пользователь разрешение на выполнение действия.	yii\rest\Action
$controller	yii\base\Controller\|yii\web\Controller	Контроллер, которому принадлежит это действие	yii\base\Action
$findModel	callable	PHP-вызов, который будет вызван для возвращения модели, соответствующей заданному значению первичного ключа.	yii\rest\Action
$id	string	ID действия	yii\base\Action
$modelClass	string	Имя класса модели, которая будет обработана этим действием.	yii\rest\Action
$uniqueId	string	Уникальный ID этого действия во всем приложении.	yii\base\Action

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__clone()	Этот метод вызывается после создания объекта путем клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__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
findModel()	Возвращает модель данных на основе заданного первичного ключа.	yii\rest\Action
getBehavior()	Возвращает объект именованного поведения.	yii\base\Component
getBehaviors()	Возвращает все прикрепленные к этому компоненту поведения.	yii\base\Component
getUniqueId()	Возвращает уникальный ID этого действия во всем приложении.	yii\base\Action
hasEventHandlers()	Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\rest\Action
off()	Открепляет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Прикрепляет обработчик событий к событию.	yii\base\Component
run()	Отображает модель.	yii\rest\ViewAction
runWithParams()	Выполняет это действие с указанными параметрами.	yii\base\Action
trigger()	Вызывает событие.	yii\base\Component

Защищенные методы

Метод	Описание	Определено в
afterRun()	Этот метод вызывается сразу после `run()`.	yii\base\Action
beforeRun()	Этот метод вызывается непосредственно перед `run()`.	yii\base\Action

Подробное описание методов

run() публичный метод

Отображает модель.

public yii\db\ActiveRecordInterface run ( $id )
$id	string	Первичный ключ модели.
return	yii\db\ActiveRecordInterface	Отображаемая модель

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-rest-viewaction.html