Class yii\rest\ActiveController

ActiveController implements a common set of actions for supporting RESTful access to ActiveRecord.

The class of the ActiveRecord should be specified via $modelClass, which must implement yii\db\ActiveRecordInterface. By default, the following actions are supported:

• index: list of models
• view: return the details of a model
• create: create a new model
• update: update an existing model
• delete: delete an existing model
• options: return the allowed HTTP methods

You may disable some of these actions by overriding actions() and unsetting the corresponding actions.

To add a new action, either override actions() by appending a new action class or write a new action method. Make sure you also override verbs() to properly declare what HTTP methods are allowed by the new action.

You should usually override checkAccess() to check whether the current user has the privilege to perform the specified action against the specified model.

For more details and usage information on ActiveController, see the guide article on rest controllers.

Public Properties

Public Methods

Protected Methods

Events

Property Details

$createScenario public property

The scenario used for creating a model.

See also yii\base\Model::scenarios().

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

$modelClass public property

The model class name. This property must be set.

public string $modelClass = null

$updateScenario public property

The scenario used for updating a model.

See also yii\base\Model::scenarios().

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

Method Details

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