pronist/pager

Pagination (Pager) for PHP


Keywords
php, pager, pagination, 2019, package, php-pagination
License
MIT

Documentation

Pagination.php

Pagination for PHP

Installation

composer require pronist/pagination

Getting Started

require "vendor/autoload.php";

use Pronist\Pagination;

$pager = 'page';
$current_page = $_GET[$pager]; 

/** 
 * this is pager variable
 * localhost/?page=1
 */
if(!isset($current_page)) $current_page = 1;

$pagination = new Pagination();

$pagination
    ->set_pager($pager)
    ->set_current_page($current_page)
    ->set_page_link($_SERVER['PHP_SELF'])
    ->set_limit_content(5)
    /** 
     * if your post is 31 pages, the pagination is 7
     * bacause each page has been set to display as 5 contents
     */
    ->set_content_count(31)
    /** 
     * how many content do you display pagination?
     * this is set to display 5 pagers
     */ 
    ->set_page_size(5)
;

$pagination->ready();

/** get links about the pages! */
$links = $pagination->get_pages_link();

foreach($links as $key => $link):
    if($key != $current_page):
        echo "<a href='$link'>$key</a>";
    else: 
        echo "<strong>$key</strong>";
    endif;
endforeach;

Methods

new Pagination()

Create Pagination Instance

Usage

$pagination = new Pagination();

Pagination:::set_page_size(int $size): Pagination

Setting pagination size

Usage

$pagination->set_page_size(5);

Pagination::set_current_page(int $current_page): Pagination

Setting current page

Usage

$pagination->set_current_page($_GET[$pager]);

Pagination::set_pager(string $pager): Pagination

Setting pager name

Usage

$pagination->set_pager('page');

Pagination::set_limit_content(int $limit): Pagination

Setting the content size of each page

Usage

$pagination->set_limit_content(5);

Pagination::set_page_link(string $page_link): Pagination

Setting page link prefix URL

Usage

$pagination->set_page_link($_SERVER['PHP_SELF']);

Pagination::set_content_count(int $count): Pagination

Setting content size

Usage

$pagination->set_content_count(31);

Pagination::ready(): void

If you are ready for pagination

Usage

$pagination->ready();

Pagination::get_prev_link(): string

Getting previous page link

Usage

$prev_link = $pagination->get_prev_link();

Pagination::get_next_link(): string

Getting next page link

Usage

$next_link = $pagination->get_next_link();

Pagination::get_first_link(): string

Getting first page link

Usage

$first_link = $pagination->get_first_link();

Pagination::get_last_link(): string

Getting last page link

Usage

$last_link = $pagination->get_last_link();

Pagination::get_pages_link(): array

Getting page links you set page size

Usage

$links = $pagination->get_pages_link();

foreach($links as $key => $link):
    if($key != $current_page):
        echo "<a href='$link'>$key</a>";
    else: 
        echo "<strong>$key</strong>";
    endif;
endforeach;

License

MIT

Copyright (c) Mansu Jeong. All rights reserved.