Documentation

Pagination extends Plugin

in package

• Application

implements IteratorAggregate, JsonSerializable

Pagination accepts a pagination object generated by the Builder system to create a loopable set of objects you can include in a template.

$builder = $this->getDI()->getArticleManager()->getBuilder()
    ->setPage($page)
    ->setLimit($perPage)
    ->byTags($section->tags)
    ->paginate();

$articles = $builder->getItems();
$paginator = (new Pagination)
    ->setPagination($builder->getPagination())
    ->setLimit($perPage)
    ->build();

{% for page in paginator %}
 <a href="{{ page.url }}">{{ page.label }}</a>
{% endfor %}

Interfaces, Classes and Traits

IteratorAggregate

JsonSerializable

Table of Contents

$allLinks  : mixed

$built  : mixed

$first  : mixed

$last  : mixed

$limit  : mixed

$next  : mixed

$pages  : mixed

$pagination  : mixed

$params  : mixed

$placeholders  : mixed

$previous  : mixed

$show  : mixed

$url  : mixed

__construct()  : mixed

Create new paginator If no url is provided, will use current.

build()  : self

Build pagination. Called automatically on first attempt to access pages

getFirst()  : object

Get first page

getIterator()  : ArrayIterator

Allow for iterator access

getLast()  : object

Get last page

getNext()  : object

Get next page

getPages()  : array<string|int, mixed>

Get all numbered pages, e.g. not first/last and next/previous

getPrevious()  : object

Get previous page

jsonSerialize()  : array<string|int, mixed>

Allow for proper JSON serialization

rebuild()  : self

Force a rebuild of pagination. Really only useful if you reset the pagination object or url options after building

setLimit()  : self

Set the number of items per page

setPagination()  : self

Set the pagination object

setParams()  : self

Set extra query params, note that reserved words will be unset

setShow()  : self

Set number of pages to show for sliding pagination

setUrl()  : self

Set the base pagination URL. Will substitute page and per_page attributes