irongomme/extended-paginator

ExtendedPaginator plugin for CakePHP

ExtendedPaginator plugin for CakePHP

Simple plugin to extend CakePHP 3 Paginator Component, with customized and additionnals queryParams., _(*1)

Installation

You can install this plugin into your CakePHP application using composer., _(*2)

The recommended way to install composer packages is:, _(*3)

composer require irongomme/ExtendedPaginator

Then load it in your app:, _(*4)

./bin/cake plugin load ExtendedPaginator

And configure it in your controller:, _(*5)

public function initialize()
{
    parent::initialize();

    $this->loadComponent('Paginator', [
        'className' => 'ExtendedPaginator.ExtendedPaginator'
    ]);
}

available options

Fields choice for paginated model

• queryParam = fields
• values = comma separated fields

Ex: http://myapp/articles?limit=100&fields=title,content, _(*6)

Will output:, _(*7)

{
    results: [
        {
            id: 1,
            title: "Lorem Ipsum",
            content: "Lorem Ipsum Lorem Ipsum Lorem Ipsum ..."
        },
        {
            ...
        }
    ]
}

Unique sorting and multiple sorting with single queryParam

• queryParam = sort
• values = comma separated fields, prefix with - for desc

Ex: http://myapp/articles?limit=100&sort=title,-author_id, _(*8)

Will sort by title ascending, then by author_id descending., _(*9)

Contain associated models

• queryParam = contain
• values = comma separated models, with optionnal fields selection in it, by collapsing [field1,field2,...] to model name

Ex: http://myapp/articles?limit=100&contain=authors[firstname,lastname] Ex: http://myapp/articles?limit=100&contain=authors,category[name], _(*10)

If no fields are specified, all fields will be shown., _(*11)