Class yii\rest\IndexAction

Data filter to be used for the search filter composition. You must set up this field explicitly in order to enable filter processing. For example:

[
    'class' => 'yii\data\ActiveDataFilter',
    'searchModel' => function () {
        return (new \yii\base\DynamicModel(['id' => null, 'name' => null, 'price' => null]))
            ->addRule('id', 'integer')
            ->addRule('name', 'trim')
            ->addRule('name', 'string')
            ->addRule('price', 'number');
    },
]

See also yii\data\DataFilter.

The pagination to be used by prepareDataProvider(). If this is false, it means pagination is disabled. Note: if a Pagination object is passed, it's params will be set to the request parameters.

See also yii\data\Pagination.

A PHP callable that will be called to prepare a data provider that should return a collection of the models. If not set, prepareDataProvider() will be used instead. The signature of the callable should be:

function (IndexAction $action) {
    // $action is the action object currently running
}

The callable should return an instance of yii\data\ActiveDataProvider.

If $dataFilter is set the result of yii\data\DataFilter::build() will be passed to the callable as a second parameter. In this case the signature of the callable should be the following:

function (IndexAction $action, mixed $filter) {
    // $action is the action object currently running
    // $filter the built filter condition
}

A PHP callable that will be called to prepare query in prepareDataProvider. Should return $query. For example:

function ($query, $requestParams) {
    $query->andFilterWhere(['id' => 1]);
    ...
    return $query;
}

The sorting to be used by prepareDataProvider(). If this is false, it means sorting is disabled. Note: if a Sort object is passed, it's params will be set to the request parameters.

See also yii\data\Sort.