Класс yii\rest\CreateAction
| Наследование | yii\rest\CreateAction » 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/CreateAction.php |
CreateAction реализует конечную точку API для создания новой модели из предоставленных данных.
Для получения дополнительной информации и справочных данных по CreateAction, обратитесь к статье руководства по контроллерам 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 |
| $scenario | string | Сценарий, который будет назначен новой модели перед проверкой и сохранением. | yii\rest\CreateAction |
| $uniqueId | string | Уникальный идентификатор этого действия в рамках всего приложения. | yii\base\Action |
| $viewAction | string | Имя действия представления. | yii\rest\CreateAction |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| run() | Создает новую модель. | yii\rest\CreateAction |
| runWithParams() | Выполняет это действие с указанными параметрами. | yii\base\Action |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| afterRun() | Этот метод вызывается сразу после того, как run() выполнено. | yii\base\Action |
| beforeRun() | Этот метод вызывается непосредственно перед тем, как run() выполнено. | yii\base\Action |
Подробности свойств
$scenario публичное свойство
Сценарий, который будет назначен новой модели перед ее проверкой и сохранением.
public string $scenario = \yii\base\Model::SCENARIO_DEFAULT
$viewAction публичное свойство
Имя действия представления. Это свойство необходимо для создания URL при успешном создании модели.
public string $viewAction = 'view'
Подробности методов
run() public method
Создаёт новую модель.
| public yii\db\ActiveRecordInterface run ( ) | ||
|---|---|---|
| return | yii\db\ActiveRecordInterface |
Созданная модель |
| throws | yii\web\ServerErrorHttpException |
если при создании модели произошла ошибка |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-rest-createaction.html
