Yii2: How do change Pagination-Per-Page into RESTful Web Service API?

Question

I am developing an application using AngularJS for the frontend and Yii2 for the backend.

The frontend requires a comprehensive array of all users.

In the documentation of Yii2, http://www.yiiframework.com/doc-2.0/guide-rest-quick-start.html I can read the result divided by X-Pagination-Per-Page: 20

How do I set X-Pagination-Per-Page: ALL ??

Answer 1

If you are using yii\rest\ActiveController as parent from your controller, you need to override the action index in your controller.

This is my code

class StnkController extends ActiveController{
    public $modelClass = "common\models\Stnk";

    public function actions(){
        $actions = parent::actions();
        unset($actions['index']);
        return $actions;
    }

    public function actionIndex(){
        $activeData = new ActiveDataProvider([
            'query' => Stnk::find(),
            'pagination' => [
                'defaultPageSize' => 2,
            ],
        ]);
        return $activeData;
    }
}

Answer 2

See this example from official documentation.

You can set any necessary number by changing pageSize parameter of pagination:

return new ActiveDataProvider([
    'pagination' => [
        'pageSize' => 10,
    ],
]);

Or you can disable pagination completely and show all available data like this:

return new ActiveDataProvider([
    'pagination' => false,
]);

I don't think this is a right way to pass ALL because it's taken directly from pageSize (which is number).

In case of disabling this header will not be added.

Answer 3

Here says that you can get all records if you set pageSize less than 1.

But the pageSize must be in range of pageSizeLimit. pageSizeLimit has a default value [1, 50] so it can't be less than 1 unless you override it.

return new ActiveDataProvider([
    'pagination' => [
        'pageSizeLimit' => [0, 50],
    ],
]);

Now you can set pageSize value to 0 to get all records.

Example;

http://localhost/users?per-page=0

Answer 4

code for the data items on index page per page in yii2 framework

insert code into the models\ModelnameSearch.php File into the $query statement

public $pageSize=10;

$dataProvider = new ActiveDataProvider([
        'query' => $query,
        'pagination' =>  ['pageSize' => $pageSize,],       
    ]);

Answer 5

Almost all the answers suggest to customize the pagination by creating a new ActiveDataProvider. By doing so you lost lost the default behaviours of the yii\rest\IndexAction, such as sorting and filtering.

In fact, yii\rest\IndexAction is pretty flexible and allows overriding the minimal you need. To customize only the pagination, you can set the pagination property of the IndexAction without having to create your own ActiveDataProvider, e.g.:

class CatController extends \yii\rest\ActiveController
{
    public static $modelClass = '\app\models\Cat';

    public function actions()
    {
        return array_merge_recursive(parent::actions(), [
            'index' => [
                'pagination' => [
                    'defaultPageSize' => 50,
                    'pageSizeLimit' => [1, 50],
                ],
            ],
        ]);
    }
}

The trick above is the use of array_merge_recursive() such that the custom params are merged with the default ones, leaving the other default behaviours to work.

The entire list of pagination parameters can be found in the API doc. It is up to you to decide the combination that fits the application most, e.g.:

• set a larger defaultPageSize
• set pageSizeLimit to allow pageSize of 0, i.e. all items
• disable pagination at all by setting it to false

Answer 6

In yii/rest/IndexAction.php change

return new ActiveDataProvider([
        'query' => $modelClass::find(),
    ]);

to

return new ActiveDataProvider([
        'query' => $modelClass::find(),
        'pagination' => false,
    ]);

That's all.