PHP Класс yii\rest\Action

For more details and usage information on Action, see the guide article on rest controllers.
С версии: 2.0
Автор: Qiang Xue ([email protected])
Наследование: extends yii\base\Action
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$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.

Открытые методы

Метод Описание
findModel ( string $id ) : yii\db\ActiveRecordInterface Returns the data model based on the primary key given.
init ( )

Описание методов

findModel() публичный Метод

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.
Результат yii\db\ActiveRecordInterface the model found

init() публичный Метод

public init ( )

Описание свойств

$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) }
public $checkAccess

$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.
public $findModel

$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 $modelClass