README

PHP Pagination Library - Open Source

Damian Pagination PHP - Open Source Pagination

Introduction - Damian Pagination PHP

Damian Pagination PHP is an open-source PHP library designed to provide simple yet comprehensive pagination functionality.

This pagination library is compatible with all PHP projects (with or without MVC frameworks) and is also compatible with Bootstrap 5 CSS.

Key Features

Simple library for pagination.
Customizable per page options.
Support for multiple languages.
Compatible with Bootstrap 5.

Paginate easily without limits 🚀

Basic Example

<?php

$pagination = new \DamianPaginationPhp\Pagination();

$pagination->paginate($countElements);

$limit = $pagination->getLimit();
$offset = $pagination->getOffset();

echo $pagination->render();
echo $pagination->perPageForm();

Author

This package is developed by Stephen Damian.

✨ If you find this package useful, please star it on the GitHub repository.

Requirements

PHP 8.0 || 8.1 || 8.2 || 8.3

Introduction

This Open Source pagination contains PHP files, and one CSS style sheet.

An example of a CSS style sheet is in vendor/s-damian/damian-pagination-php/src/css directory. You can edit them according to your needs.

This pagination library also allows you to generate a per page form. This will generate an HTML <form> tag with a <select> element and clickable options.

Installation

With Composer

composer require s-damian/damian-pagination-php

Without Composer

If you do not use Composer, you must manually require the necessary files before using this package. Example:

<?php

require_once './your-path/damian-pagination-php/src/DamianPaginationPhp/bootstrap/load.php';

Pagination Instance Methods

Examples

Simple Example

<?php

use DamianPaginationPhp\Pagination;

$pagination = new Pagination();

$pagination->paginate($countElements);

$limit = $pagination->getLimit();
$offset = $pagination->getOffset();

// Here your SQL query with $limit and $offset

// Then your listing of elements with a loop

echo $pagination->render();
echo $pagination->perPageForm();

Example rendering of pagination with Bootstrap 5:

Example With SQL Queries

<?php

use DamianPaginationPhp\Pagination;

// Count articles in DB
function countArticles(): int
{
    $sql = "SELECT COUNT(*) AS nb FROM articles";
    $query = db()->query($sql);
    $result = $query->fetch();
    
    return $result->nb;
}

// Collect articles from DB
function findArticles($limit, $offset)
{
    $sql = "SELECT * FROM articles LIMIT ? OFFSET ?";
    $query = db()->prepare($sql);
    $query->bindValue(1, $limit, PDO::PARAM_INT);
    $query->bindValue(2, $offset, PDO::PARAM_INT);
    $query->execute();

    return $query;
}

// Creating an object Pagination
$pagination = new Pagination();

// Paginate
$pagination->paginate(countArticles());

$limit = $pagination->getLimit();
$offset = $pagination->getOffset();

$articles = findArticles($limit, $offset);

// Show elements one by one that are retrieved from the database
foreach ($articles as $article) {
    echo htmlspecialchars($article->title);
}

// Show the Pagination
echo $pagination->render();
// Show the per page
echo $pagination->perPageForm();

The db() function must be defined to return a database connection instance, such as PDO.

Depending on your needs, you can also use this library with your favorite ORM.

Example With a List of Files of a Directory

<?php

use DamianPaginationPhp\Pagination;

$scandir = scandir('your_path_upload');

$listFilesFromPath = [];
$count = 0;
foreach ($scandir as $f) {
    if ($f !== '.' && $f !== '..') {
        $listFilesFromPath[] = $f;
        $count++;
    }
}

// Creating an object Pagination
$pagination = new Pagination();

// Paginate
$pagination->paginate($count);

$limit = $pagination->getLimit();
$offset = $pagination->getOffset();

// Listing
$files = array_slice($listFilesFromPath, $offset, $limit);

// Show files one by one
foreach ($files as $file) {
    echo $file;
}

// Show the Pagination
echo $pagination->render();
// Show the per page
echo $pagination->perPageForm();

Instance Options

<?php

use DamianPaginationPhp\Pagination;

// To change the number of elements displayed per page:
$pagination = new Pagination(['pp' => 50]);
// Is 15 by default

// To change number of links alongside the current page:
$pagination = new Pagination(['number_links' => 10]);
// Is 5 by default

// To change the choice to select potentially generate with perPageForm():
$pagination = new Pagination(['options_select' => [5, 10, 50, 100, 500, 'all']]);
// The value of 'options_select' must be an array.
// Only integers and 'all' are permitted.
// Options are [15, 30, 50, 100, 200, 300] by default.

// To change the CSS style of the pagination (to another CSS class as default):
$pagination = new Pagination(['css_class_p' => 'name-css-class-of-pagination']);
// The CSS class name is by default "pagination".

// To change the CSS style of the pagination active (to another CSS class as default):
$pagination = new Pagination(['css_class_link_active' => 'name-css-class-of-pagination']);
// The active CSS class name is by default "active".

// To change the CSS style of a per page (select) (to another id as default):
$pagination = new Pagination(['css_id_pp' => 'name-css-id-of-per-page-form']);
// The CSS ID name is by default "per-page-form".

// To use Bootstrap CSS:
$pagination = new Pagination(['css_class_p' => 'pagination']);
// The CSS class name is by default "block-pagination"
// We must put "pagination"

Language Configuration

You can change the default language, which is English ('en') by default.

Supported languages: cn, de, ee, en, es, fr, it, jp, pt, ru.

Set default language:

<?php

use DamianPaginationPhp\Config\Config;

// Change the language to French ('fr').
// Note: It's in English ('en') by default.
Config::set(["lang" => "fr"]);

Support

If you discover a bug or a security vulnerability, please send a message to Stephen. Thank you.

All bugs and all security vulnerabilities will be promptly addressed.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

s-damian / damian-pagination-php

Maintainers

Details