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.
Mostrar archivo
Open project: yiisoft/yii2
Class Usage Examples
Public Properties
Public Methods
Protected Methods
Method |
Description |
|
verbs ( ) |
|
|
Method Details
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 |
Property Details
$createScenario public_oe property
the scenario used for creating a model.
$modelClass public_oe property
the model class name. This property must be set.
$updateScenario public_oe property
the scenario used for updating a model.