PHP Class yii\rest\Action

For more details and usage information on Action, see the guide article on rest controllers.
Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends yii\base\Action
Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$checkAccess a PHP callable that will be called when running an action to determine if the current user has the permission to execute the action. If not set, the access check will not be performed. The signature of the callable should be as follows, php function ($action, $model = null) { $model is the requested model instance. If null, it means no specific model (e.g. IndexAction) }
$findModel a PHP callable that will be called to return the model corresponding to the specified primary key value. If not set, Action::findModel will be used instead. The signature of the callable should be: php function ($id, $action) { $id is the primary key value. If composite primary key, the key values will be separated by comma. $action is the action object currently running } The callable should return the model found, or throw an exception if not found.
$modelClass class name of the model which will be handled by this action. The model class must implement [[ActiveRecordInterface]]. This property must be set.

Public Methods

Method Description
findModel ( string $id ) : yii\db\ActiveRecordInterface Returns the data model based on the primary key given.
init ( )

Method Details

findModel() public method

If the data model is not found, a 404 HTTP exception will be raised.
public findModel ( string $id ) : yii\db\ActiveRecordInterface
$id string the ID of the model to be loaded. If the model has a composite primary key, the ID must be a string of the primary key values separated by commas. The order of the primary key values should follow that returned by the `primaryKey()` method of the model.
return yii\db\ActiveRecordInterface the model found

init() public method

public init ( )

Property Details

$checkAccess public property

a PHP callable that will be called when running an action to determine if the current user has the permission to execute the action. If not set, the access check will not be performed. The signature of the callable should be as follows, php function ($action, $model = null) { $model is the requested model instance. If null, it means no specific model (e.g. IndexAction) }
public $checkAccess

$findModel public property

a PHP callable that will be called to return the model corresponding to the specified primary key value. If not set, Action::findModel will be used instead. The signature of the callable should be: php function ($id, $action) { $id is the primary key value. If composite primary key, the key values will be separated by comma. $action is the action object currently running } The callable should return the model found, or throw an exception if not found.
public $findModel

$modelClass public property

class name of the model which will be handled by this action. The model class must implement [[ActiveRecordInterface]]. This property must be set.
public $modelClass