Класс yii\rest\UpdateAction

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

Наследование	yii\rest\UpdateAction » 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/UpdateAction.php

UpdateAction реализует конечную точку API для обновления модели.

Для получения дополнительной информации и инструкции по использованию UpdateAction, см. статью руководства по контроллерам 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	Идентификатор действия	yii\base\Action
$modelClass	string	Имя класса модели, которая будет обрабатываться этим действием.	yii\rest\Action
$scenario	string	Сценарий, который будет назначен модели перед её валидацией и обновлением.	yii\rest\UpdateAction
$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
run()	Обновляет существующую модель.	yii\rest\UpdateAction
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

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

run() public method

Обновляет существующую модель.

public yii\db\ActiveRecordInterface run ( $id )
$id	string	Первичный ключ модели.
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-updateaction.html