包简介

A lightweight and flexible PHP pagination library for handling paginated data and generating pagination links.

README 文档

README

Ucscode Paginator is a lightweight PHP pagination library designed to handle paginated data efficiently. It provides an easy-to-use interface for managing and generating pagination links.

This project requires a minimum of PHP 8.2

Installation

Install the package via Composer:

composer require ucscode/easy-paginator

Usage

Creating a Paginator

use Ucscode\Paginator\Paginator;

$paginator = new Paginator(
    totalItems: 100,       // Total number of items
    itemsPerPage: 10,      // Items per page
    currentPage: 3,        // Current page
    urlPattern: '?page=(:num)' // URL pattern with placeholder
);

Getting Pagination Information

$paginator->getTotalPages();   // Total number of pages
$paginator->getCurrentPage();  // Current page number
$paginator->getNextPage();     // Next page number or null if last page
$paginator->getPrevPage();     // Previous page number or null if first page

Generating URLs

$paginator->getPageUrl(5); // Returns '?page=5'
$paginator->getNextUrl();  // URL for the next page
$paginator->getPrevUrl();  // URL for the previous page

Pagination Builder

The Builder class generates an array of Item, which can be iterated to display page links.

Example

$builder = $paginator->getBuilder();

$builder->getPrevItem(); // Item|null

foreach ($builder->getItems() as $item) {
    echo <<<HTML
        <li class="{$item->isActive() ? 'active' : ''}">
            <a href="{$item->getUrl()}" class="">
                {$item->getContent()}
            </a>
        </li>
    HTML;
}

$builder->getNextItem(); // Item|null

Pagination Items

The Builder::getItems() generates an array of Item:

[
    new Item(), 
    new Item(),
    new Item(), 
]

Where an Item contains getters and setters for the following properties:

class Item {
    protected ?string $url = null;
    protected bool $active = false;
    protected int $pageNumber = 0;
    protected string|NodeInterface $content = '';
}

For structured HTML generation, use can still use the Builder. This class converts pagination data into an HTML structure with ul and li elements, making it easy to integrate into any UI.

Example Usage

$builder = $paginator->getBuilder();

echo $builder->render();

The will generate HTML similar to bootstrap 5 pagination:

<nav class="navigation" aria-label="...">
    <ul class="pagination">
        <li class="page-item disabled">
            <span class="page-link">&laquo;</span>
        </li>
        <li class="page-item">
            <a class="page-link" href="?page=1">1</a>
        </li>
        <li class="page-item active" aria-current="page">
            <span class="page-link">2</span>
        </li>
        <li class="page-item">
            <a class="page-link" href="?page=3">3</a>
        </li>
        <li class="page-item">
            <a class="page-link" href="#">&raquo;</a>
        </li>
    </ul>
</nav>

Updating the HTML Element

You can customize the HTML Element before rendering it by taking advantage of the UssElement Library.

$navElement = $builder->createElement();

$navElement->getClassList()->add('my-nav-class');
$navElement->setAttribute('data-name', 'pagination');

$ulElement = $navElement->querySelector('ul.pagination');

$ulElement->setAttribute('id', 'nav-id')

Checkout UssELement and read the official documentation for more details

Acknowledgement

Inspired by jasongrimes/php-paginator

Licence

Easy Paginator is licensed under the MIT License.

ucscode/easy-paginator 适用场景与选型建议

ucscode/easy-paginator 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 128 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 02 月 19 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「pager」「paginator」「pagination」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 ucscode/easy-paginator 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 ucscode/easy-paginator 我们能提供哪些服务？

定制开发 / 二次开发

基于 ucscode/easy-paginator 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 ucscode/easy-paginator 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

rekalogika/rekapager-doctrine-collections-adapter 0

Doctrine Collections adapter for Rekapager pagination library

rekalogika/rekapager-core 0

Core functionality of Rekapager pagination library

rekalogika/rekapager-symfony-bridge 0

Common classes for Symfony integration.

vysokeskoly/data-grid-bundle 0

Symfony DataGridBundle

rekalogika/rekapager-bundle 0

Symfony bundle for the Rekapager library

zooxsmart/laminas-mongodb-paginator-adapter 0

MongoDB Adapter to be used with Laminas Paginator

ucscode/easy-paginator

包简介

关键字：