Класс yii\rest\DeleteAction
| Наследование | yii\rest\DeleteAction » 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/DeleteAction.php |
DeleteAction реализует конечную точку API для удаления модели.
Для получения дополнительной информации и информации об использовании DeleteAction, обратитесь к статье руководства по контроллерам rest.
Свойства Public
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $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 |
Методы Public
| Метод | Описание | Определено |
|---|---|---|
| __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\DeleteAction |
| runWithParams() | Выполняет это действие со значениями указанных параметров. | yii\base\Action |
| trigger() | Вызывает событие. | yii\base\Component |
Методы Protected
| Метод | Описание | Определено |
|---|---|---|
| afterRun() | Этот метод вызывается сразу после того, как run() выполнено. | yii\base\Action |
| beforeRun() | Этот метод вызывается сразу перед тем, как run() выполнено. | yii\base\Action |
Подробное описание методов
run() public method
Удаляет модель.
| public void run ( $id ) | ||
|---|---|---|
| $id | mixed |
ID модели, подлежащей удалению. |
| 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-deleteaction.html