README

描述

此库提供了一种便捷的方式来分页任何数据结构。

一些定义

• 一个 section 是一组页面，一起渲染。
• Proximity 是显示在当前页面前后的一定数量的页面。

例如，对于有10页、邻近度为2、当前页面为5的分页器，将会有以下页码的3个部分：[1], [3, 4, 5, 6, 7], [10]。

当当前页面靠近边缘时，部分将合并。

控制器代码示例

<?php

use Ruwork\Paginator\PaginatorBuilder;
use Ruwork\Paginator\Provider\IterableProvider;

$data = range(1, 100);

$paginator = PaginatorBuilder::create()
    // required
    ->setProvider(new IterableProvider($data))
    // defaults to 1
    // when out of range of estimated pages, PageOutOfRangeException is thrown
    ->setCurrent(2)
    // defaults to 2
    ->setProximity(1)
    // defaults to 10
    ->setPerPage(3)
    ->getPaginator();

// template logic

foreach ($paginator->getItems() as $item) {
    // render the item row
}

if (null !== $previous = $paginator->getPrevious()) {
    echo sprintf('<a href="?page=%d">Previous</a>', $previous->getNumber());
}

foreach ($paginator as $section) {
    foreach ($section as $page) {
        echo sprintf('<a href="?page=%1$d" class="%2$s">%1$d</a>', $page->getNumber(), $page->isCurrent() ? 'active' : '');
    }
}

if (null !== $next = $paginator->getNext()) {
    echo sprintf('<a href="?page=%d">Next</a>', $next->getNumber());
}

数据提供者

IterableProvider

可以使用 array 或实现 \Traversable 的对象。

DoctrineOrmProvider

可以用来分页 Doctrine 实体。内部使用原生 Doctrine\ORM\Tools\Pagination\Paginator 辅助工具。

<?php

use Ruwork\Paginator\PaginatorBuilder;
use Ruwork\Paginator\Provider\DoctrineOrmProvider;
use Doctrine\ORM\EntityRepository;

/** @var EntityRepository $repository */

$qb = $repository->createQueryBuilder('entity')
    ->andWhere('entity.id = :id')
    ->setParameters([
        'id' => 1
    ]);

$paginator = PaginatorBuilder::create()
    ->setProvider(new DoctrineOrmProvider($qb))
    ->getPaginator();

自定义

通过实现 Ruwork\Paginator\Provider\ProviderInterface 创建自己的提供者。

模板

bootstrap_4.html.twig

{% set route = app.request.attributes.get('_route') %}
{% set route_params = app.request.attributes.get('_route_params', []) %}

{% embed 'twig/bootstrap_4.html.twig' with {paginator: paginator, show_previous_next: false} %}
    {% block href path(route, route_params|merge({page: page.first ? null : page.number})) %}

    {% block previous_label 'Предыдущая' %}

    {% block next_label 'Следующая' %}
{% endembed %}