slejnej/pagination-php

A PHP pagination that accepts anything and tries to paginate it.

Maintainers

Details

github.com/slejnej/pagination-php

Homepage

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.1 2020-03-25 14:31 UTC

Requires

  • php: >=7.2

Requires (Dev)

MIT 609197d8aabf16b9269cd4744f7fbfd7ab60fd8f

  • Jernej Slejko <js.woop@jslejko.com>

pagination

This package is auto-updated.

Last update: 2024-04-25 23:03:46 UTC

README

Build Status

Light weight pagination for PHP with full control over output and displaying of data. Emulates the Mobile view with replacing excess numbers with dot-dot-dot (ellipse).

Installation

Install with composer:

composer require slejnej/pagination-php

Basic usage

Example with default values

<?php

use Slejnej\Pagination;

require '../vendor/autoload.php';

$input = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten'];
$pagination = new Pagination();
$pagination->paginate($input);
?>
<html>
    <head>
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css">
    </head>
    <body>

    <?php
      foreach ($pagination->getItems() as $item): ?>
        <div class="card">
            <div class="card-body">
                <?= $item ?>
            </div>
        </div>
    <?php
      endforeach;
      echo $pagination->getNavigationHtml();
    ?>
        <div class="text-right">
            <?= $pagination->getTotalItems(); ?> entries. Showing
            <?= $pagination->getCurrentPageFirstItem() .' - '. $pagination->getCurrentPageLastItem(); ?>.
        </div>
    </body>
</html>

Available functions

function action
getItems returns items for selected page, or empty array
setMaxPagesToShow SET number of page links in navigation (min. 3)
getMaxPagesToShow returns int number of links in navigation
getCurrentPage returns int number of current page
setItemsPerPage SET number of items per page (default: 10)
getItemsPerPage returns int number of items per page
getTotalItems returns total number of items sent to paginate
getNumPages returns int number of pages
setUrlPattern SET new navigation URL pattern (default: (:num))
getUrlPattern returns current URL pattern
getPageUrl returns URL that is created from URL pattern and page number
getNextPage returns int number or null for next page
getPrevPage returns int number or null for previous page
getNextUrl returns URL or null for next page
getPrevUrl returns URL or null for previous page
getNavigation returns array structure for entire navigation
getNavigationHtml returns navigation HTML
getCurrentPageFirstItem returns sequential number of first item on selected page
getCurrentPageLastItem returns sequential number of last item on selected page