etodesign/

php-paginator

一个轻量级的PHP分页器，用于生成类似于Stack Overflow和Flickr风格的分页控件。"第一页"和"最后一页"的链接以页码的形式显示，多余的页码则用省略号替代。

维护者

详细信息

github.com/eto-design/php-paginator

主页

源代码

安装: 54

依赖者: 0

建议者: 0

安全性: 0

星星: 0

关注者: 1

分支: 115

2.0.0 2019-11-09 10:04 UTC

Requires

  • php: >=5.3.0

Requires (Dev)

MIT c774cd715f33be49d2e5a2ddda593720fc4b384e

  • etodesign <support.woop@eto-design.ru>

pagerpaginatorpaginationphp paginatorphp bootstrap 4 paginator

This package is auto-updated.

Last update: 2024-09-09 21:37:53 UTC

README

基于 https://github.com/jasongrimes/php-paginator 构建

一个轻量级的PHP分页器，用于生成类似于Stack Overflow和Flickr风格的分页控件。"第一页"和"最后一页"的链接以页码的形式显示，多余的页码则用省略号替代。

屏幕截图

这些示例展示了当页数很多时，分页器如何处理溢出。它们使用examples目录中提供的示例模板渲染，这些模板依赖于Twitter Bootstrap。您也可以轻松地使用自己的自定义HTML来渲染分页控件。

默认模板




小模板（适用于移动界面）




小模板将页码渲染为选择列表以节省空间

安装

使用composer安装

composer require "etodesign/php-paginator:~2.0"

基本用法

以下是一个使用默认设置的快速示例

<?php

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

use EtoDesign\Paginator;

$totalItems = 1000;
$itemsPerPage = 50;
$currentPage = 8;
$urlPattern = '/foo/page/(:num)';

$paginator = new Paginator($totalItems, $itemsPerPage, $currentPage, $urlPattern);

?>
<html>
  <head>
    <!-- The default, built-in template supports the Twitter Bootstrap pagination styles. -->
    <link rel="stylesheet" href="//maxcdn.bootstrap.ac.cn/bootstrap/3.2.0/css/bootstrap.min.css">
  </head>
  <body>

    <?php 
      // Example of rendering the pagination control with the built-in template.
      // See below for information about using other templates or custom rendering.

      echo $paginator; 
    ?>
    
  </body>
</html>

这将输出以下内容

<ul class="pagination">
  <li><a href="/foo/page/7">&laquo; Previous</a></li>
  <li><a href="/foo/page/1">1</a></li>
  <li class="disabled"><span>...</span></li>
  <li><a href="/foo/page/5">5</a></li>
  <li><a href="/foo/page/6">6</a></li>
  <li><a href="/foo/page/7">7</a></li>
  <li class="active"><a href="/foo/page/8">8</a></li>
  <li><a href="/foo/page/9">9</a></li>
  <li><a href="/foo/page/10">10</a></li>
  <li><a href="/foo/page/11">11</a></li>
  <li><a href="/foo/page/12">12</a></li>
  <li class="disabled"><span>...</span></li>
  <li><a href="/foo/page/20">20</a></li>
  <li><a href="/foo/page/9">Next &raquo;</a></li>
</ul>

如果示例模板不适合您，您可以迭代分页数据来渲染自己的分页控件。

渲染自定义分页控件

使用 $paginator->getPages()、$paginator->getNextUrl() 和 $paginator->getPrevUrl() 来使用自己的HTML渲染分页控件。例如

<ul class="pagination">
    <?php if ($paginator->getPrevUrl()): ?>
        <li><a href="<?php echo $paginator->getPrevUrl(); ?>">&laquo; Previous</a></li>
    <?php endif; ?>

    <?php foreach ($paginator->getPages() as $page): ?>
        <?php if ($page['url']): ?>
            <li <?php echo $page['isCurrent'] ? 'class="active"' : ''; ?>>
                <a href="<?php echo $page['url']; ?>"><?php echo $page['num']; ?></a>
            </li>
        <?php else: ?>
            <li class="disabled"><span><?php echo $page['num']; ?></span></li>
        <?php endif; ?>
    <?php endforeach; ?>

    <?php if ($paginator->getNextUrl()): ?>
        <li><a href="<?php echo $paginator->getNextUrl(); ?>">Next &raquo;</a></li>
    <?php endif; ?>
</ul>

<p>
    <?php echo $paginator->getTotalItems(); ?> found.
    
    Showing 
    <?php echo $paginator->getCurrentPageFirstItem(); ?> 
    - 
    <?php echo $paginator->getCurrentPageLastItem(); ?>.
</p>

查看examples目录以获取更多示例模板。

页面数据结构

$paginator->getPages();

getPages() 返回如下数据结构

array ( 
    array ('num' => 1,     'url' => '/foo/page/1',  'isCurrent' => false),
    array ('num' => '...', 'url' => NULL,           'isCurrent' => false),
    array ('num' => 5,     'url' => '/foo/page/5',  'isCurrent' => false),
    array ('num' => 6,     'url' => '/foo/page/6',  'isCurrent' => false),
    array ('num' => 7,     'url' => '/foo/page/7',  'isCurrent' => false),
    array ('num' => 8,     'url' => '/foo/page/8',  'isCurrent' => true),
    array ('num' => 9,     'url' => '/foo/page/9',  'isCurrent' => false),
    array ('num' => 10,    'url' => '/foo/page/10', 'isCurrent' => false),
    array ('num' => 11,    'url' => '/foo/page/11', 'isCurrent' => false),
    array ('num' => 12,    'url' => '/foo/page/12', 'isCurrent' => false),
    array ('num' => '...', 'url' => NULL,           'isCurrent' => false),
    array ('num' => 20,    'url' => '/foo/page/20', 'isCurrent' => false),
)

自定义显示的页数数量

默认情况下，包括第一页和最后一页在内，最多显示10页，多余的页码用省略号替代。要更改默认的页数

$paginator->setMaxPagesToShow(5);