Interface rootlocal\crud\components\SearchModelInterface

SearchModelInterface is an interface that should be implemented in classes of search models.

examples:

use rootlocal\crud\components\SearchModelInterface;

class BookSearch extends Book implements SearchModelInterface
{

     // ...

     public function search($params = [])
     {
         // ...
         return $dataProvider;
     }
}

See also rootlocal\crud\actions\IndexAction.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
search() Creates data provider instance with search query applied rootlocal\crud\components\SearchModelInterface

Method Details

search() public abstract method

Creates data provider instance with search query applied

public abstract yii\data\ActiveDataProvider search ( $params = [] )
$params array

The request GET parameter values.

return yii\data\ActiveDataProvider

ActiveDataProvider implements a data provider based on yii\db\Query and yii\db\ActiveQuery.