ActiveController

API reference › yii › rest › ActiveController

class	`yii\rest\ActiveController`
Extends	`Controller` » `yii\web\Controller` » `yii\base\Controller` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/rest/ActiveController.php`

ActiveController implements a common set of actions for supporting RESTful access to ActiveRecord.

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 actions() and unsetting the corresponding actions.

To add a new action, either override actions() by appending a new action class or write a new action method. Make sure you also override verbs() to properly declare what HTTP methods are allowed by the new action.

You should usually override checkAccess() to check whether the current user has the privilege to perform the specified action against the specified model.

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

Properties

Property	Type	Description	Defined by
`$action`	`yii\base\Action<static>\|null`	The action that is currently being executed. Default: `null`.	`yii\base\Controller`
`$actionParams`	`array`	The parameters bound to the current action. Default: `[]`.	`yii\web\Controller`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$createScenario`	`string`	The scenario used for creating a model. Default: `\yii\base\Model::SCENARIO_DEFAULT`.	`ActiveController`
`$defaultAction`	`string`	The ID of the action that is used when the action ID is not specified in the request. Default: `'index'`.	`yii\base\Controller`
`$enableCsrfValidation`	`bool`	Default: `false`.	`Controller`
`$id`	`string`	The ID of this controller. Default: `null`.	`yii\base\Controller`
`$layout`	`string\|null\|false`	The name of the layout to be applied to this controller’s views. Default: `null`.	`yii\base\Controller`
`$modelClass`	`string`	The model class name. Default: `null`.	`ActiveController`
`$module`	`yii\base\T`	The module that this controller belongs to. Default: `null`.	`yii\base\Controller`
`$modules` read-only	`yii\base\Module[]`	All ancestor modules that this controller is located within.	`yii\base\Controller`
`$request`	`yii\web\Request`	The request object.	`yii\web\Controller`
`$response`	`yii\web\Response`	The response object.	`yii\web\Controller`
`$route` read-only	`string`	The route (module ID, controller ID and action ID) of the current request.	`yii\base\Controller`
`$serializer`	`string\|array`	The configuration for creating the serializer that formats the response data. Default: `'yii\rest\Serializer'`.	`Controller`
`$uniqueId` read-only	`string`	The controller ID that is prefixed with the module ID (if any).	`yii\base\Controller`
`$updateScenario`	`string`	The scenario used for updating a model. Default: `\yii\base\Model::SCENARIO_DEFAULT`.	`ActiveController`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\web\Controller`
`$viewPath`	`string`	The directory containing the view files for this controller.	`yii\base\Controller`

Methods

Method	Description	Defined by
`__construct()`		`yii\base\Controller`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`actions()`	Declares external actions for the controller.	`ActiveController`
`afterAction()`	This method is invoked right after an action is executed.	`Controller`
`asJson()`	Send data formatted as JSON.	`yii\web\Controller`
`asXml()`	Send data formatted as XML.	`yii\web\Controller`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`beforeAction()`	This method is invoked right before an action is executed.	`yii\web\Controller`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`Controller`
`bindActionParams()`	Binds the parameters to the action.	`yii\web\Controller`
`bindActionParamsToCallable()` static	Resolves the parameters for an action’s invokable callable using the same scalar coercion, type validation, and DI rules as `bindActionParams()`.	`yii\web\Controller`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`checkAccess()`	Checks the privilege of the current user.	`ActiveController`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`createAction()`	Creates an action based on the given action ID.	`yii\base\Controller`
`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`
`findLayoutFile()`	Finds the applicable layout file.	`yii\base\Controller`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getModules()`	Returns all ancestor modules of this controller.	`yii\base\Controller`
`getRoute()`	Returns the route of the current request.	`yii\base\Controller`
`getUniqueId()`	Returns the unique ID of the controller.	`yii\base\Controller`
`getView()`	Returns the view object that can be used to render views or view files.	`yii\base\Controller`
`getViewPath()`	Returns the directory containing view files for this controller.	`yii\base\Controller`
`goBack()`	Redirects the browser to the last visited page.	`yii\web\Controller`
`goHome()`	Redirects the browser to the home page.	`yii\web\Controller`
`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`ActiveController`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`redirect()`	Redirects the browser to the specified URL.	`yii\web\Controller`
`refresh()`	Refreshes the current page.	`yii\web\Controller`
`render()`	Renders a view and applies layout if available.	`yii\base\Controller`
`renderAjax()`	Renders a view in response to an AJAX request.	`yii\web\Controller`
`renderContent()`	Renders a static string by applying a layout.	`yii\base\Controller`
`renderFile()`	Renders a view file.	`yii\base\Controller`
`renderPartial()`	Renders a view without applying layout.	`yii\base\Controller`
`run()`	Runs a request specified in terms of a route.	`yii\base\Controller`
`runAction()`	Runs an action within this controller with the specified action ID and parameters.	`yii\base\Controller`
`setView()`	Sets the view object to be used by this controller.	`yii\base\Controller`
`setViewPath()`	Sets the directory that contains the view files.	`yii\base\Controller`
`trigger()`	Triggers an event.	`yii\base\Component`
`bindInjectedParams()` protected final	Fills parameters based on types and names in action method signature.	`yii\base\Controller`
`serializeData()` protected	Serializes the specified data.	`Controller`
`verbs()` protected	Declares the allowed HTTP verbs.	`ActiveController`

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_ACTION`	`yii\base\ActionEvent`	An event raised right before executing a controller action. Event name: `'beforeAction'`.	`yii\base\Controller`
`EVENT_AFTER_ACTION`	`yii\base\ActionEvent`	An event raised right after executing a controller action. Event name: `'afterAction'`.	`yii\base\Controller`

Property details

$modelClass

public string $modelClass = null

The model class name.

This property must be set.

Method details

actions()

public function actions(): array<array-key, class-string|array{class: class-string}>

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

Returns

array<array-key, class-string|array{class: class-string}>

checkAccess()

public function checkAccess(string $action, object|null $model = null, array $params = []): mixed

Checks the privilege of the current user.

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.

Parameters

Parameter	Type	Description
`$action`	`string`	The ID of the action to be executed
`$model`	`object\|null`	The model to be accessed. If null, it means no specific model is being accessed.
`$params`	`array`	Additional parameters

Returns

mixed

Throws

yii\web\ForbiddenHttpException: if the user does not have access

init()

public function init(): mixed

Initializes the object.

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

Returns

mixed

Since

2.0.36

verbs()

protected function verbs(): array

Declares the allowed HTTP verbs.

Please refer to VerbFilter::$actions on how to declare the allowed verbs.

Returns

array: The allowed HTTP verbs.