library pager {🖫 8,377, ⚐ 8, ★ 17}

kgilden/pager

A paginator library to split results into multiple pages

Friday, November 10, 2017
by kgilden
Repository
2 Watchers
17 Stars
8,377 Installations

PHP
1 Dependents
0 Suggesters
2 Forks
2 Open issues
8 Versions
4 % Grown

The README.md

, _(*1)

Pager is a library to split results to multiple pages - any way you want them!, _(*2)

Features

5 built-in adapters for arrays, Doctrine ORM, ElasticSearch & MongoDB;
safe subset of methods to not even count items;
strategies to split pages inequally (i.e. 2 last pages merged);
integrates nicely with Symfony's HttpKernel to infer the current page;
provides a bundle to seamlessly integrate with Symfony;

Documentation

Read the documentation, _(*3)

Usage

Two objects work together to split a set of items to pages: pager and adapter. Pagers act as factories for pages. Adapters allow concrete item sets to be paged (for example there's an adapter for Doctrine queries)., _(*4)

Here's an example with arrays (check out the docs for more):, _(*5)

paginate(new ArrayAdapter($list), $itemsPerPage, $currentPage);

$page->isFirst(); // false
$page->isLast(); // true - there's a total of 3 pages
$page->getNumber(); // 3 - it's $currentPage

count($page->getItems()); // 1
$page->getItems(); // ["eggplant"]

?>