Класс yii\rest\ActiveController

ActiveController реализует общий набор действий для поддержки RESTful доступа к ActiveRecord.

Класс ActiveRecord должен быть указан через $modelClass, который должен реализовывать yii\db\ActiveRecordInterface. По умолчанию поддерживаются следующие действия:

• index: список моделей
• view: возвращает подробности модели
• create: создание новой модели
• update: обновление существующей модели
• delete: удаление существующей модели
• options: возвращает разрешенные HTTP-методы

Вы можете отключить некоторые из этих действий, переопределив actions() и удалив соответствующие действия.

Для добавления нового действия переопределите actions(), добавив новый класс действия, или напишите новый метод действия. Убедитесь, что вы также переопределили verbs(), чтобы правильно объявить, какие HTTP-методы разрешены новым действием.

Обычно необходимо переопределить checkAccess(), чтобы проверить, имеет ли текущий пользователь право выполнить указанное действие над указанной моделью.

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

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

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

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

События

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

$createScenario общественное свойство

Сценарий, используемый для создания модели.

См. также yii\base\Model::scenarios().

public string $createScenario = \yii\base\Model::SCENARIO_DEFAULT

$modelClass общественное свойство

Имя класса модели. Это свойство должно быть установлено.

public string $modelClass = null

$updateScenario общественное свойство

Сценарий, используемый для обновления модели.

См. также yii\base\Model::scenarios().

public string $updateScenario = \yii\base\Model::SCENARIO_DEFAULT

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

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];