Download the PHP package tuum/pagination without Composer
On this page you can find all versions of the php package tuum/pagination. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tuum/pagination
More information about tuum/pagination
Files in tuum/pagination
Package pagination
Short Description a generic pagination package for PSR-7.
License MIT
Informations about the package pagination
Pagination
A generic pagination package for classic offset/limit style.
Some interesting features maybe:
- stores the current page and form inputs in session,
- can use PSR-7 ServerRequestInterface object,
- have a flexible pagination HTML generator.
In short, accessing the page with _page
will restore the last pagination result.
PSR
PSR-1, PSR-2, PSR-4, and PSR-7.
License
MIT license
installation
Please use composer to install WScore/Pagination package.
Getting Started with a Sample Code
The page key variable, _page
, is the key.
sample HTML form
Let's start with an HTML form for a pagination, for example;
Please note that there should be no _page
variables.
paginating a query
The simplest way to use a Pagination
class that combines all the functionalities.
To instantiate a Pageinate
object,
The Inputs::get*
methods should provides information to construct a query. The Inputs::setList
method sets the found results inside.
The type
and num
values are:
- taken from the form input and then saved to a session if no
_page
variables are present in the input query, or - taken from a session data (if
_page
is present).
_page
with page number
Requesting with only the page number will restore the query values (type and num) from the session, and set the offset value from the page number. For instance,
will set offset, (_page-1)*_limit
, with the page number being 2
.
query with only _page
Requesting with _page
but no page number will restore the page number and other parameters from the session. For instance,
will set offset to the page number of last request.
generating pagination HTML
The Pagination class implements a __toString
method to output pagination HTML string. As a default, the Pagination object outputs following style of pagination HTML for Bootstrap ver3.
It is possible to change the pagination and HTML/CSS style by modifying the pagination logic and html formatter, such that;
Technical Details
setting a total
The pager does not know how to get a total; please supply the total count in the closure inside the call method usging Inputs::setTotal
method;
security
As a default, the input values are validated to contain no nulls as well as a valid UTF-8 string.
To change the validation, you can pass it at the construction of Pager
as;
FYI: this is the default closure.