Class yii\rest\Action

Inheritanceyii\rest\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Subclassesyii\rest\CreateAction, yii\rest\DeleteAction, yii\rest\IndexAction, yii\rest\UpdateAction, yii\rest\ViewAction
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/rest/Action.php

Action is the base class for action classes that implement RESTful API.

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

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$checkAccess callable A PHP callable that will be called when running an action to determine if the current user has the permission to execute the action. yii\rest\Action
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller The controller that owns this action yii\base\Action
$findModel callable A PHP callable that will be called to return the model corresponding to the specified primary key value. yii\rest\Action
$id string ID of the action yii\base\Action
$modelClass string Class name of the model which will be handled by this action. yii\rest\Action

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
findModel() Returns the data model based on the primary key given. yii\rest\Action
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getUniqueId() Returns the unique ID of this action among the whole application. yii\base\Action
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\rest\Action
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
runWithParams() Runs this action with the specified parameters. yii\base\Action
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
afterRun() This method is called right after run() is executed. yii\base\Action
beforeRun() This method is called right before run() is executed. yii\base\Action

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,

function ($action, $model = null) {
    // $model is the requested model instance.
    // If null, it means no specific model (e.g. IndexAction)
}
public callable $checkAccess null
$findModel public property

A PHP callable that will be called to return the model corresponding to the specified primary key value. If not set, findModel() will be used instead. The signature of the callable should be:

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 callable $findModel null
$modelClass public property

Class name of the model which will be handled by this action. The model class must implement yii\db\ActiveRecordInterface. This property must be set.

public string $modelClass null

Method Details

findModel() public method

Returns the data model based on the primary key given.

If the data model is not found, a 404 HTTP exception will be raised.

public yii\db\ActiveRecordInterface findModel ( $id )
$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

throws yii\web\NotFoundHttpException

if the model cannot be found

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )