分页 · October Cms 笔记

# 分页 ### 基本用法有几种分页记录的方法，最常见的是`paginate`在查询或模型上调用该方法。这将返回一个特殊的分页集合，其中添加了额外的方法来显示结果。 ### [](https://octobercms.com/docs/services/pagination#paginating-query-builder-results)分页查询构建器结果有几种分页项目的方法。最简单的`paginate`方法是使用[查询构建器](https://octobercms.com/docs/database/query)上的方法或[模型查询](https://octobercms.com/docs/database/model)。该`paginate`方法会自动根据用户正在查看的当前页面来设置适当的限制和偏移。默认情况下，当前页面由`?page`HTTP请求上查询字符串参数的值检测。当然，该值将被自动检测并自动插入到分页器生成的链接中。首先，让我们看一下在`paginate`查询上调用方法。在此示例中，传递给的唯一参数`paginate`是您希望“每页”显示的项目数。在这种情况下，我们指定要在`15`每页显示项目： ~~~ $users = Db::table('users')->paginate(15); ~~~ > **注意：**当前，使用`groupBy`语句的分页操作无法有效执行。如果需要使用`groupBy`带有分页结果集的，建议您查询数据库并手动创建分页器。 #### 简单分页如果只需要在分页视图中显示简单的“下一个”和“上一个”链接，则可以选择使用该`simplePaginate`方法来执行更有效的查询。如果在渲染视图时不需要为每个页码显示链接，则这对于大型数据集非常有用： ~~~ $users = Db::table('users')->simplePaginate(15); ~~~ ### [](https://octobercms.com/docs/services/pagination#paginating-eloquent-results)分页模型结果您也可以分页[数据库模型](https://octobercms.com/docs/database/model)查询。在此示例中，我们将在每页项目上对`User`模型进行分页`15`。如您所见，语法与分页查询构建器结果几乎相同： ~~~ $users = User::paginate(15); ~~~ 当然，您可以`paginate`在对查询设置其他约束（例如`where`子句）之后调用 ~~~ $users = User::where('votes', '>', 100)->paginate(15); ~~~ 您可以`simplePaginate`在分页模型时使用该方法： ~~~ $users = User::where('votes', '>', 100)->simplePaginate(15); ~~~ 您可以通过传递第二个参数来手动指定页码，在此我们将`15`每页的页码分页，指定我们在页面上`2`： ~~~ $users = User::where('votes', '>', 100)->paginate(15, 2); ~~~ ### [](https://octobercms.com/docs/services/pagination#manually-creating-a-paginator)手动创建分页器有时您可能希望手动创建一个分页实例，并向其传递一系列项目。您可以根据需要通过创建一个`Illuminate\Pagination\Paginator`或`Illuminate\Pagination\LengthAwarePaginator`实例来实现。本`Paginator`类并不需要知道结果集中项目的总数，因为这个类的没有用于检索的最后一页的索引方法。在`LengthAwarePaginator`接受几乎相同的参数`Paginator`，但它确实需要在结果集中的项目总数的计数。换句话说，`Paginator`对应于`simplePaginate`查询构建器和模型`LengthAwarePaginator`上的`paginate`方法，而对应于方法。手动创建分页器实例时，应手动“切片”传递给分页器的结果数组。如果不确定如何执行此操作，请查看[array\_slice](http://php.net/manual/en/function.array-slice.php)PHP函数。 ### [](https://octobercms.com/docs/services/pagination#displaying-results-in-a-view)在视图中显示结果当您在查询构建器或模型查询上调用`paginate`or`simplePaginate`方法时，您将收到一个分页程序实例。调用该`paginate`方法时，您将收到的实例`Illuminate\Pagination\LengthAwarePaginator`。调用该`simplePaginate`方法时，您将收到的实例`Illuminate\Pagination\Paginator`。这些对象提供了几种描述结果集的方法。除了这些辅助方法之外，分页器实例是迭代器，并且可以作为数组循环。因此，一旦检索到结果，就可以显示结果并使用Twig呈现页面链接： ~~~ <div class="container"> {% for user in users %} {{ user.name }} {% endfor %} </div> {{ users.render|raw }} ~~~ 该`render`方法将呈现到结果集中其余页面的链接。这些链接中的每个链接都已经包含正确的`?page`查询字符串变量。该`render`方法生成的HTML与[Bootstrap CSS框架](https://getbootstrap.com/)兼容。 > **注意：**`render`从Twig模板调用方法时，请确保使用`|raw`过滤器，以免HTML链接被转义。 #### 自定义分页器URI 该`setPath`方法允许您自定义在生成链接时分页程序使用的URI。例如，如果您希望分页程序生成类似的链接`http://example.com/custom/url?page=N`，则应传递`custom/url`给`setPath`方法： ~~~ $users = User::paginate(15); $users->setPath('custom/url'); ~~~ #### 附加到分页链接您可以使用`appends`方法将查询链接添加到分页链接的字符串中。例如，要附加`&sort=votes`到每个分页链接，您应该对进行以下调用`appends`： ~~~ {{ users.appends({sort: 'votes'}).render|raw }} ~~~ 如果您希望在分页器的URL后面附加“散列片段”，则可以使用该`fragment`方法。例如，要附加`#foo`到每个分页链接的末尾，请对该`fragment`方法进行以下调用： ~~~ {{ users.fragment('foo').render|raw }} ~~~ #### 其他辅助方法您还可以通过以下方法在分页程序实例上访问其他分页信息： ~~~ $results->count() $results->currentPage() $results->hasMorePages() $results->lastPage() (Not available when using simplePaginate) $results->nextPageUrl() $results->perPage() $results->previousPageUrl() $results->total() (Not available when using simplePaginate) $results->url($page) ~~~ ### [](https://octobercms.com/docs/services/pagination#converting-results-to-json)将结果转换为JSON 分页器结果类实现`Illuminate\Contracts\Support\JsonableInterface`协定并公开`toJson`方法，因此将分页结果转换为JSON非常容易。您还可以通过简单地从路由或AJAX处理程序返回分页程序实例将其转换为JSON： ~~~ Route::get('users', function () { return User::paginate(); }); ~~~ 从分页程序的JSON将包括元数据信息，例如`total`，`current_page`，`last_page`，和更多。实际结果对象将通过`data`JSON数组中的键提供。这是通过从路由返回分页程序实例而创建的JSON的示例： #### 示例分页器JSON ~~~ { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "next_page_url": "http://octobercms.app?page=2", "prev_page_url": null, "from": 1, "to": 15, "data":[ { // Result Object }, { // Result Object } ] } ~~~