分页

CodeIgniter 提供了一个非常简单但灵活的分页库,它易于主题化,可与模型一起使用,并且能够在单个页面上支持多个分页器。

加载库
对模型进行分页
手动分页
仅分页预期查询
自定义链接
- 视图配置
- 创建视图

加载库 

与 CodeIgniter 中的所有服务一样,它可以通过 Config\Services 加载,尽管你通常不需要手动加载它:

<?php

$pager = \Config\Services::pager();

手动分页 

你可能会发现有时你只需要根据已知数据创建分页。你可以使用 makeLinks() 方法手动创建链接,该方法的参数分别是当前页面、每页结果数和总项数:

<?php

namespace App\Controllers;

use CodeIgniter\Controller;

class UserController extends Controller
{
    public function index()
    {
        // ...

        $pager = service('pager');

        $page    = (int) ($this->request->getGet('page') ?? 1);
        $perPage = 20;
        $total   = 200;

        // Call makeLinks() to make pagination links.
        $pager_links = $pager->makeLinks($page, $perPage, $total);

        $data = [
            // ...
            'pager_links' => $pager_links,
        ];

        return view('users/index', $data);
    }
}
?>

<!-- In your view file: -->
<?= $pager_links ?>

默认情况下,这将以一系列链接的正常方式显示链接,但你可以通过作为第四个参数传递模板的名称来更改使用的显示模板。更多细节可以在以下部分中找到:

$pager->makeLinks($page, $perPage, $total, 'template_name');

如前一节所述,也可以使用 URI 段作为页面编号,而不是页面查询参数。将要使用的段编号指定为 makeLinks() 的第五个参数:

$pager->makeLinks($page, $perPage, $total, 'template_name', $segment);

请注意: $segment 值不能大于 URI 段数加 1。

如果你需要在一页上显示多个分页器,那么定义组的额外参数可能会有所帮助:

<?php

$pager = service('pager');
$pager->setPath('path/for/my-group', 'my-group'); // Additionally you could define path for every group.
$pager->makeLinks($page, $perPage, $total, 'template_name', $segment, 'my-group');

分页库默认使用 page 查询参数进行 HTTP 查询(如果未给出组或 default 组名称)或自定义组名称的 page_[groupName]。

自定义链接 

视图配置 

将链接渲染到页面时,它们使用视图文件来描述 HTML。你可以通过编辑 app/Config/Pager.php 轻松更改使用的视图:

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class Pager extends BaseConfig
{
    public $templates = [
        'default_full'   => 'CodeIgniter\Pager\Views\default_full',
        'default_simple' => 'CodeIgniter\Pager\Views\default_simple',
    ];

    // ...
}

此设置存储要使用的视图的别名和命名空间视图路径。default_full 和 default_simple 视图分别用于 links() 和 simpleLinks() 方法。要应用程序范围内更改显示方式,可以在此处分配一个新视图。

例如,假设你创建了一个与 Foundation CSS 框架一起使用的新视图文件,并将该文件放在 app/Views/Pagers/foundation_full.php 中。由于 application 目录用作 App 命名空间,其下的所有目录直接映射到命名空间的段,因此你可以通过它的命名空间定位视图文件:

'default_full' => 'App\Views\Pagers\foundation_full'

但是,由于它在标准的 app/Views 目录下,你不需要命名空间,因为 view() 方法可以通过文件名定位它。在这种情况下,你可以简单地提供子目录和文件名:

'default_full' => 'Pagers/foundation_full'

一旦你创建了视图并在配置中设置了它,它将自动使用。你不需要替换现有模板。你可以在配置文件中创建尽可能多的附加模板。一个常见的情况是前端和后端需要不同的样式。

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class Pager extends BaseConfig
{
    public $templates = [
        'default_full'   => 'CodeIgniter\Pager\Views\default_full',
        'default_simple' => 'CodeIgniter\Pager\Views\default_simple',
        'front_full'     => 'App\Views\Pagers\foundation_full',
    ];

    // ...
}

一旦配置完成,你可以将其指定为 links()、simpleLinks() 和 makeLinks() 方法中的最后一个参数:

<?= $pager->links('group1', 'front_full') ?>
<?= $pager->simpleLinks('group2', 'front_full') ?>
<?= $pager->makeLinks($page, $perPage, $total, 'front_full') ?>

创建视图 

创建新视图时,你只需要创建生成分页链接本身所需的代码。你不应该创建不必要的包装 div,因为它可能在多个地方使用,你只会限制它们的有用性。通过展示你如何使用现有的 default_full 模板来创建一个新视图,可以很容易地演示如何创建新视图:

<?php $pager->setSurroundCount(2) ?>

<nav aria-label="Page navigation">
    <ul class="pagination">
    <?php if ($pager->hasPrevious()) : ?>
        <li>
            <a href="<?= $pager->getFirst() ?>" aria-label="<?= lang('Pager.first') ?>">
                <span aria-hidden="true"><?= lang('Pager.first') ?></span>
            </a>
        </li>
        <li>
            <a href="<?= $pager->getPrevious() ?>" aria-label="<?= lang('Pager.previous') ?>">
                <span aria-hidden="true"><?= lang('Pager.previous') ?></span>
            </a>
        </li>
    <?php endif ?>

    <?php foreach ($pager->links() as $link): ?>
        <li <?= $link['active'] ? 'class="active"' : '' ?>>
            <a href="<?= $link['uri'] ?>">
                <?= $link['title'] ?>
            </a>
        </li>
    <?php endforeach ?>

    <?php if ($pager->hasNext()) : ?>
        <li>
            <a href="<?= $pager->getNext() ?>" aria-label="<?= lang('Pager.next') ?>">
                <span aria-hidden="true"><?= lang('Pager.next') ?></span>
            </a>
        </li>
        <li>
            <a href="<?= $pager->getLast() ?>" aria-label="<?= lang('Pager.last') ?>">
                <span aria-hidden="true"><?= lang('Pager.last') ?></span>
            </a>
        </li>
    <?php endif ?>
    </ul>
</nav>

setSurroundCount()

在第一行中, setSurroundCount() 方法指定我们希望在当前页面链接的两侧显示两个链接。它只接受显示链接数的参数。

hasPrevious() & hasNext()

这些方法返回一个布尔值,如果根据传给 setSurroundCount() 的值,在当前页面的任一侧有更多可以显示的链接,则返回 true。例如,假设我们有 20 页数据。当前页面是第 3 页。如果周围计数为 2,那么将在列表中显示以下链接:1、2、3、4 和 5。由于显示的第一个链接是第 1 页,所以 hasPrevious() 将返回 false,因为没有 0 页。但是, hasNext() 将返回 true,因为在第 5 页之后还有 15 页结果。

getPrevious() & getNext()

这些方法返回在编号链接任一侧当前页面之前和之后的结果页面的 URL。

例如,你将当前页面设置为 5,并希望它前后(surroundCount)的链接分别为 2 个,这将给你这样的结果:

3  |  4  |  5  |  6  |  7

getPrevious() 返回第 2 页的 URL。getNext() 返回第 8 页的 URL。

如果你想要第 4 页和第 6 页,请改用 getPreviousPage() 和 getNextPage()。

getFirst() & getLast()

与 getPrevious() 和 getNext() 类似,这些方法返回结果集中的第一页和最后一页的链接。

links()

返回有关所有编号链接的数据数组。每个链接的数组都包含链接的 uri、标题(只是数字)以及一个布尔值,告知链接是否是当前/活动链接:

<?php

$link = [
    'active' => false,
    'uri'    => 'https://example.com/foo?page=2',
    'title'  => 1,
];

在为标准分页结构提供的代码中,使用 getPrevious() 和 getNext() 方法分别获取前一个和下一个分页组的链接。

如果你要使用上一页和下一页将链接到当前页面基于当前页面的上一页和下一页的分页结构,只需分别用 getPreviousPage() 和 getNextPage() 替换 getPrevious() 和 getNext(),以及分别用 hasPreviousPage() 和 hasNextPage() 替换 hasPrevious() 和 hasNext()。

请参阅以下示例及其更改:

<nav aria-label="<?= lang('Pager.pageNavigation') ?>">
    <ul class="pagination">
        <?php if ($pager->hasPreviousPage()) : ?>
            <li>
                <a href="<?= $pager->getFirst() ?>" aria-label="<?= lang('Pager.first') ?>">
                    <span aria-hidden="true"><?= lang('Pager.first') ?></span>
                </a>
            </li>
            <li>
                <a href="<?= $pager->getPreviousPage() ?>" aria-label="<?= lang('Pager.previous') ?>">
                    <span aria-hidden="true"><?= lang('Pager.previous') ?></span>
                </a>
            </li>
        <?php endif ?>

        <?php foreach ($pager->links() as $link): ?>
            <li <?= $link['active'] ? 'class="active"' : '' ?>>
                <a href="<?= $link['uri'] ?>">
                    <?= $link['title'] ?>
                </a>
            </li>
        <?php endforeach ?>

        <?php if ($pager->hasNextPage()) : ?>
            <li>
                <a href="<?= $pager->getNextPage() ?>" aria-label="<?= lang('Pager.next') ?>">
                    <span aria-hidden="true"><?= lang('Pager.next') ?></span>
                </a>
            </li>
            <li>
                <a href="<?= $pager->getLast() ?>" aria-label="<?= lang('Pager.last') ?>">
                    <span aria-hidden="true"><?= lang('Pager.last') ?></span>
                </a>
            </li>
        <?php endif ?>
    </ul>
</nav>

hasPreviousPage() & hasNextPage()

该方法分别返回一个布尔值,指示当前显示页面之前和之后是否存在链接。

它们与 hasPrevious() 和 hasNext() 的区别在于,它们基于当前显示的页面,而 hasPrevious() 和 hasNext() 基于传入 setSurroundCount() 的值设置在当前页面之前和之后的链接集。

getPreviousPage() & getNextPage()

这些方法返回当前显示页面之前和之后的页面的 URL,与 getPrevious() 和 getNext() 不同,后两者返回编号链接任一侧之前和之后的结果页面的 URL。请参阅前一段落的完整说明。

例如,你将当前页面设置为 5,并希望它前后(surroundCount)的链接分别为 2 个,这将给你这样的结果:

3  |  4  |  5  |  6  |  7

getPreviousPage() 返回第 4 页的 URL。getNextPage() 返回第 6 页的 URL。

如果你想要页面数而不是 URL,可以使用以下方法:

getPreviousPageNumber() & getNextPageNumber()

这些方法返回当前显示页面之前和之后的页面号。

getFirstPageNumber() & getLastPageNumber()

这些方法分别返回结果集中的第一页和最后一页的页码。

getCurrentPageNumber()

该方法返回当前页面的页码。

getPageCount()

该方法返回总页数。

分页