PHP Class yii\rest\ActiveController

The class of the ActiveRecord should be specified via [[modelClass]], which must implement 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 ActiveController::actions and unsetting the corresponding actions. To add a new action, either override ActiveController::actions by appending a new action class or write a new action method. Make sure you also override ActiveController::verbs to properly declare what HTTP methods are allowed by the new action. You should usually override ActiveController::checkAccess to check whether the current user has the privilege to perform the specified action against the specified model.
Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends Controller
Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$createScenario the scenario used for creating a model.
$modelClass the model class name. This property must be set.
$updateScenario the scenario used for updating a model.

Public Methods

Method Description
actions ( )
checkAccess ( string $action, object $model = null, array $params = [] ) Checks the privilege of the current user.
init ( )

Protected Methods

Method Description
verbs ( )

Method Details

actions() public method

public actions ( )

checkAccess() public method

This method should be overridden to check whether the current user has the privilege to run the specified action against the specified data model. If the user does not have access, a [[ForbiddenHttpException]] should be thrown.
public checkAccess ( string $action, object $model = null, array $params = [] )
$action string the ID of the action to be executed
$model object the model to be accessed. If null, it means no specific model is being accessed.
$params array additional parameters

init() public method

public init ( )

verbs() protected method

protected verbs ( )

Property Details

$createScenario public property

the scenario used for creating a model.
See also: yii\base\Model::scenarios()
public $createScenario

$modelClass public property

the model class name. This property must be set.
public $modelClass

$updateScenario public property

the scenario used for updating a model.
See also: yii\base\Model::scenarios()
public $updateScenario