medisolbv/pagination

A simple package to allow easy generation of pagination links

Maintainers

Details

github.com/medisolbv/pagination

Source

Issues

Installs: 85

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

1.0.0 2024-09-06 08:15 UTC

Requires

  • php: ^8.2

Requires (Dev)

MIT b1872bb663f0c141eea1defcca3732a4b5635651

This package is not auto-updated.

Last update: 2025-07-12 10:27:41 UTC

README

This is a simple package to generate the correct pagination links.

Usage

A new Paginator object can be instantiated with the Paginator::create method. This method takes two parameters;

  1. int $currentPage
  2. int $totalPages.

Generating links

After instantiating a new Paginator object, the generate method can be used to generate the required links.

Getting the links

After generating links, you can use these links by calling the Paginator::getLinks method. When returning the result in JSON format, the links will be serialized to JSON.

Available link methods

  • PaginationLink::getPage: returns the link's page number
  • PaginationLink::isActive: returns whether the current page is this page
  • PaginationLink::isDisabled: returns whether this page is disabled (for example, the ellipsis between different link ranges).