Класс yii\rest\Action
| Наследование | yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\rest\CreateAction, yii\rest\DeleteAction, yii\rest\IndexAction, yii\rest\UpdateAction, yii\rest\ViewAction |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/rest/Action.php |
Action — базовый класс для классов действий, реализующих RESTful API.
Для получения дополнительной информации и руководства по использованию Action, см. статью руководства по контроллерам 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 | Уникальный идентификатор этого действия в рамках всего приложения. | 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() | Возвращает уникальный идентификатор этого действия в рамках всего приложения. | 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 |
| runWithParams() | Выполняет это действие с указанными параметрами. | yii\base\Action |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено |
|---|---|---|
| afterRun() | Этот метод вызывается сразу после run(). | yii\base\Action |
| beforeRun() | Этот метод вызывается сразу перед run(). | yii\base\Action |
Подробности свойств
$checkAccess общедоступное свойство
Вызываемый фрагмент PHP, который будет вызван при выполнении действия для определения, имеет ли текущий пользователь разрешение на выполнение действия. Если не задано, проверка доступа не будет выполнена. Подпись вызываемого фрагмента должна быть следующей:
function ($action, $model = null) {
// $model is the requested model instance.
// If null, it means no specific model (e.g. IndexAction)
}
public callable $checkAccess = null
$findModel общедоступное свойство
Вызываемый фрагмент PHP, который будет вызван для возвращения модели, соответствующей заданному значению первичного ключа. Если не задано, будет использоваться findModel(). Подпись вызываемого фрагмента должна быть:
function ($id, $action) {
// $id is the primary key value. If composite primary key, the key values
// will be separated by comma.
// $action is the action object currently running
}
Вызываемый фрагмент должен возвращать найденную модель или генерировать исключение, если модель не найдена.
public callable $findModel = null
$modelClass общедоступное свойство
Имя класса модели, которая будет обрабатываться этим действием. Класс модели должен реализовывать yii\db\ActiveRecordInterface. Это свойство должно быть установлено.
public string $modelClass = null
Подробное описание методов
findModel() общедоступный метод
Возвращает модель данных на основе первичного ключа.
Если модель данных не найдена, будет поднято исключение 404 HTTP.
| общедоступный yii\db\ActiveRecordInterface findModel ( $id ) | ||
|---|---|---|
| $id | string |
Идентификатор модели для загрузки. Если модель имеет составной первичный ключ, идентификатор должен быть строкой значений первичного ключа, разделенных запятыми. Порядок значений первичного ключа должен соответствовать тому, который возвращается методом |
| return | yii\db\ActiveRecordInterface |
Найденная модель |
| throws | yii\web\NotFoundHttpException |
если модель не найдена |
init() общедоступный метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| общедоступный void init ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-rest-action.html