Настройка действий

Настройка действий

По умолчанию [[yii\rest\ActiveController]] предоставляет набор из следующих действий:

• [[yii\rest\IndexAction|index]]: постраничный список ресурсов;
• [[yii\rest\ViewAction|view]]: возвращает подробную информацию об указанном ресурсе;
• [[yii\rest\CreateAction|create]]: создание нового ресурса;
• [[yii\rest\UpdateAction|update]]: обновление существующего ресурса;
• [[yii\rest\DeleteAction|delete]]: удаление указанного ресурса;
• [[yii\rest\OptionsAction|options]]: возвращает поддерживаемые HTTP-методы.

Все эти действия объявляются в методе [[yii\rest\ActiveController::actions()|actions()]]. Вы можете настроить эти действия или отключить какие-то из них, переопределив метод actions(), как показано ниже:

public function actions()
{
    $actions = parent::actions();

    // отключить действия "delete" и "create"
    unset($actions['delete'], $actions['create']);

    // настроить подготовку провайдера данных с помощью метода "prepareDataProvider()"
    $actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider'];

    return $actions;
}

public function prepareDataProvider()
{
    // подготовить и вернуть провайдер данных для действия "index"
}

Чтобы узнать, какие опции доступны для настройки классов отдельных действий, обратитесь к соответствующим разделам справочника классов.