Class rootlocal\crud\controllers\ActiveController

All Classes | Properties | Methods | Events
Inheritancerootlocal\crud\controllers\ActiveController » rootlocal\crud\components\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Available since version1.0.6

Base CRUD Controller

The class of the ActiveRecord should be specified via $modelClass, $modelSearchClass which must implement yii\db\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
  • validate: validate model

Example:

use rootlocal\crud\test\app\models\db\Book;
use rootlocal\crud\test\app\models\search\BookSearch;

class CrudController extends ActiveController
{
     public $modelClass = Book::class;
     public $modelSearchClass = BookSearch::class;
}

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.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$action yii\base\Action The action that is currently being executed. yii\base\Controller
$actionParams array The parameters bound to the current action. yii\web\Controller
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$createScenario string The scenario used for creating a model. rootlocal\crud\components\Controller
$defaultAction string The ID of the action that is used when the action ID is not specified in the request. yii\base\Controller
$enableCsrfValidation boolean Whether to enable CSRF validation for the actions in this controller. yii\web\Controller
$id string The ID of this controller. yii\base\Controller
$layout null|string|false The name of the layout to be applied to this controller's views. yii\base\Controller
$modelClass string String model class name rootlocal\crud\components\Controller
$modelSearchClass string String search model name rootlocal\crud\components\Controller
$module yii\base\Module The module that this controller belongs to. yii\base\Controller
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$uniqueId 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. rootlocal\crud\components\Controller
$view yii\base\View|\yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

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
accessControl() List of access rule objects or configuration arrays for creating the rule objects. rootlocal\crud\controllers\ActiveController
actions() Declares external actions for the controller rootlocal\crud\controllers\ActiveController
afterAction() This method is invoked right after an action is executed. yii\base\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. rootlocal\crud\components\Controller
bindActionParams() Binds the parameters to the action. yii\web\Controller
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
checkAccess() Checks the privilege of the current user. rootlocal\crud\controllers\ActiveController
className() 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
getDataProvider() Creates data provider instance with search query applied rootlocal\crud\controllers\ActiveController
getModelClass() Get modelClass rootlocal\crud\components\Controller
getModelSearchClass() Get modelSearchClass rootlocal\crud\components\Controller
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\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
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
setModelClass() Set modelClass rootlocal\crud\components\Controller
setModelSearchClass() Set modelSearchClass rootlocal\crud\components\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
verbs() Declares the allowed HTTP verbs. rootlocal\crud\controllers\ActiveController

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

Method Details

accessControl() public method

List of access rule objects or configuration arrays for creating the rule objects.

If a rule is specified via a configuration array, it will be merged with yii\filters\AccessRule first before it is used for creating the rule object.

Example:

public function accessControl()
{
return [[
     'actions' => [
         'index',
         'view',
         'create',
         'update',
         'delete',
     ],
     'allow' => true,
     'roles' => ['@']]];
}
public array accessControl ( )
actions() public method

Declares external actions for the controller

{@inheritdoc}

Examples:

public function actions()
{
     $actions = parent::actions();
     unset($actions['delete'], $actions['create']);
     $actions['index']['dataProvider'] = [$this, 'getDataProvider'];
     return $actions;
}

public function getDataProvider()
{
}
public array actions ( )
checkAccess() public method

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 \yii\web\ForbiddenHttpException should be thrown.

Example:

public function checkAccess($action, $model = null)
{
     if ($action === 'update' || $action === 'delete') {
         if ($model->author_id !== \Yii::$app->user->id){
             throw new \yii\web\ForbiddenHttpException(sprintf(
                 'You can only %s articles that you\'ve created.', $action));
         }
     }
}
public void checkAccess ( $action, $model = null )
$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.
getDataProvider() public method

Creates data provider instance with search query applied

See also:

public yii\data\ActiveDataProvider getDataProvider ( $model, $queryParams = [] )
$model rootlocal\crud\components\SearchModelInterface

ActiveRecord searchModel
$queryParams array

The request GET parameter values.
return yii\data\ActiveDataProvider

ActiveDataProvider object
verbs() public method

Declares the allowed HTTP verbs.

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

Example:

public function verbs()
{
     return [
         'index' => ['GET'],
         'view' => ['GET'],
         'create' => ['GET', 'POST'],
         'update' => ['GET', 'PUT', 'POST'],
         'delete' => ['POST', 'DELETE'],
     ];
}
public array verbs ( )
return array

The allowed HTTP verbs.