Class rootlocal\crud\actions\IndexAction

Inheritancerootlocal\crud\actions\IndexAction » rootlocal\crud\components\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject
Implementsrootlocal\crud\components\ActionInterface, yii\base\Configurable

Class IndexAction Lists all SearchModelInterface models.

examples:

// lambda function:
public function actions()
{
     'index' => [
         'class' => IndexAction::class,
         'searchModel' => function () {
             return new BookSearch();
         },
         'dataProvider' => function ($model, $queryParams) {
             $model->query = $model::find()->active();
             return $model->search($queryParams);
         }
     ]
}

// string:
public function actions()
{
     'index' => [
         'class' => IndexAction::class,
         'searchModel' => BookSearch::class
     ]
}

// ActiveRecord:
public function actions()
{
     'index' => [
         'class' => IndexAction::class,
         'model' => new BookSearch()
     ]
}

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$checkAccess Closure|array 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. rootlocal\crud\components\Action
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller The controller that owns this action yii\base\Action
$dataProvider yii\data\ActiveDataProvider ActiveDataProvider object rootlocal\crud\actions\IndexAction
$id string ID of the action yii\base\Action
$model rootlocal\crud\components\SearchModelInterface ActiveRecord searchModel object instanceof rootlocal\crud\components\SearchModelInterface rootlocal\crud\actions\IndexAction
$queryParams array The request GET parameter values. rootlocal\crud\actions\IndexAction
$searchModel Closure|string|rootlocal\crud\components\SearchModelInterface|array ActiveRecord searchModel rootlocal\crud\actions\IndexAction
$uniqueId string The unique ID of this action among the whole application. yii\base\Action
$view string The view name. rootlocal\crud\actions\IndexAction

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\Action
__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
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getDataProvider() Get DataProvider object rootlocal\crud\actions\IndexAction
getModel() Get ActiveRecord searchModel rootlocal\crud\actions\IndexAction
getQueryParams() Get The request GET parameter values. rootlocal\crud\actions\IndexAction
getSearchModel() Get ActiveRecord searchModel rootlocal\crud\actions\IndexAction
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\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
run() Runs the action. rootlocal\crud\actions\IndexAction
runWithParams() Runs this action with the specified parameters. yii\base\Action
setDataProvider() Get DataProvider rootlocal\crud\actions\IndexAction
setSearchModel() Set ActiveRecord searchModel rootlocal\crud\actions\IndexAction
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

$dataProvider public property

ActiveDataProvider object

public yii\data\ActiveDataProvider getDataProvider ( )
public void setDataProvider ( $dataProvider )
$model public read-only property

ActiveRecord searchModel object instanceof rootlocal\crud\components\SearchModelInterface

$queryParams public read-only property

The request GET parameter values.

$searchModel public property

ActiveRecord searchModel

$view public property

The view name.

public string $view 'index'

Method Details

getDataProvider() public method

Get DataProvider object

public yii\data\ActiveDataProvider getDataProvider ( )
return yii\data\ActiveDataProvider

ActiveDataProvider object

throws yii\base\InvalidConfigException

if dataProvider not instanceof yii\data\ActiveDataProvider

getModel() public method

Get ActiveRecord searchModel

public rootlocal\crud\components\SearchModelInterface getModel ( )
return rootlocal\crud\components\SearchModelInterface

ActiveRecord searchModel object instanceof rootlocal\crud\components\SearchModelInterface

throws yii\base\ErrorException

if searchModel not instanceof rootlocal\crud\components\SearchModelInterface

throws yii\base\InvalidConfigException

if the configuration is invalid

getQueryParams() public method

Get The request GET parameter values.

public array getQueryParams ( )
return array

The request GET parameter values.

getSearchModel() public method

Get ActiveRecord searchModel

public Closure|string|rootlocal\crud\components\SearchModelInterface|array getSearchModel ( )
return Closure|string|rootlocal\crud\components\SearchModelInterface|array

ActiveRecord searchModel

throws yii\base\ErrorException

if Model not specified (not set)

run() public method

Runs the action.

public string run ( )
setDataProvider() public method

Get DataProvider

public void setDataProvider ( $dataProvider )
$dataProvider Closure

Anonymous function for yii\data\ActiveDataProvider

setSearchModel() public method

Set ActiveRecord searchModel

public void setSearchModel ( $searchModel )
$searchModel Closure|string|rootlocal\crud\components\SearchModelInterface|array

ActiveRecord searchModel