Class rootlocal\crud\actions\IndexAction
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
Public Methods
| Method | Description | Defined 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
| Method | Description | Defined 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
ActiveDataProvider object
ActiveRecord searchModel object instanceof rootlocal\crud\components\SearchModelInterface
The request GET parameter values.
ActiveRecord searchModel
public void setSearchModel ( $searchModel )
The view name.
Method Details
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 |
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 |
Get The request GET parameter values.
| public array getQueryParams ( ) | ||
| return | array | The request GET parameter values. |
|---|---|---|
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) |
Runs the action.
| public string run ( ) |
Get DataProvider
| public void setDataProvider ( $dataProvider ) | ||
| $dataProvider | Closure | Anonymous function for yii\data\ActiveDataProvider |
Set ActiveRecord searchModel
| public void setSearchModel ( $searchModel ) | ||
| $searchModel | Closure|string|rootlocal\crud\components\SearchModelInterface|array | ActiveRecord searchModel |