README

此包添加了paginate路由方法，以支持通过自定义路由进行分页，而不是使用查询字符串。这还允许轻松翻译分页路由，例如：/news/page/2，/nieuws/pagina/2。

安装

通过Composer

composer require preprlabs/laravel-pretty-pagination

首先在您的应用程序中注册服务提供者和外观。

// config/app.php

'providers' => [
    ...
    'Preprlabs\PaginateRoute\PaginateRouteServiceProvider',
];

'aliases' => [
    ...
    'PaginateRoute' => 'Preprlabs\PaginateRoute\PaginateRouteFacade',
];

然后，在App\Providers\RouteServiceProvider::boot()中注册宏。

// app/Providers/RouteServiceProvider.php

use Preprlabs\PaginateRoute\PaginateRouteFacade as PaginateRoute;

// ...

public function boot()
{
    PaginateRoute::registerMacros(); // Add this line

    parent::boot();
}

使用方法

paginate路由宏将为您注册两个路由。

// app/Http/routes.php

// Generates /users & /users/page/{page}
Route::paginate('users', 'UsersController@index');

在您的路由操作中，您可以仅使用Laravel的常规分页方法。

// app/Http/Controllers/UsersController.php

public function index()
{
    return view('users.index', ['users' => \App\User::simplePaginate(5)]);
}

如果您想自定义或添加“页面”URL段的翻译，可以发布语言文件。

php artisan vendor:publish --provider="Preprlabs\PaginateRoute\PaginateRouteServiceProvider"

生成URL

由于Laravel的分页器URL仍将使用查询字符串，PaginateRoute有其自己的URL生成器和页面辅助函数。

@if(PaginateRoute::hasPreviousPage())
  <a href="{{ PaginateRoute::previousPageUrl() }}">Previous</a>
@endif

@if(PaginateRoute::hasNextPage($users))
  <a href="{{ PaginateRoute::nextPageUrl($users) }}">Next</a>
@endif

nextPage函数需要一个分页器实例作为参数，以便确定是否还有更多记录。

/**
 * @param  \Illuminate\Contracts\Pagination\Paginator $paginator
 * @return int|null
 */
public function nextPage(Paginator $paginator)

/**
 * @param  \Illuminate\Contracts\Pagination\Paginator $paginator
 * @return bool
 */
public function hasNextPage(Paginator $paginator)

/**
 * @param  \Illuminate\Contracts\Pagination\Paginator $paginator
 * @return string|null
 */
public function nextPageUrl(Paginator $paginator)

/**
 * @return int|null
 */
public function previousPage()

/**
 * @return bool
 */
public function hasPreviousPage()

/**
 * @param  bool $full
 * @return string|null
 */
public function previousPageUrl($full = false)

/**
 * @param int  $page
 * @param bool $full
 * @return string
 */
public function pageUrl($page, $full = false)

如果$full为true，则第一页将是一个完全限定的URL。例如：/users/page/1而不是/users（这是默认设置）。

要获取分页路由特定页面的URL（不是当前路由），可以使用addPageQuery函数。

/**
 * @param string $url
 * @param int $page
 * @param bool $full
 * @return string
 */
public function addPageQuery($url, $page, $full = false)

您还可以获取包含所有可用URL的数组。这些可以作为纯HTML列表中的页码渲染。请注意，这些函数需要一个LengthAwarePaginator。

/**
 * @param  \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
 * @param  bool $full
 * @return array
 */
public function allUrls(LengthAwarePaginator $paginator, $full = false)

/**
 * @param  \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
 * @param  bool $full
 * @param  string $class
 * @param  bool $additionalLinks
 * @return string
 */
public function renderPageList(LengthAwarePaginator $paginator, $full = false, $class = null, $additionalLinks = false)

/**
 * Example : {!! PaginateRoute::renderPageList($items,true,'pagination',true) !!}
 */
<!-- Example output: -->
<ul class="pagination">
    <li><a href="http://example.com/news">1</a></li>
    <li><a href="http://example.com/news/page/2">2</a></li>
    <li class="active"><a href="http://example.com/news/page/3">3</a></li>
    <li><a href="http://example.com/news/page/4">4</a></li>
    <li><a href="http://example.com/news/page/4">&raquo;</a></li>
</ul>

您还可以渲染标记上一页和下一页的链接标签以进行SEO。请注意，这些函数需要一个LengthAwarePaginator。

/**
 * @param  \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
 * @param  bool $full
 * @return string
 */
public function renderRelLinks(LengthAwarePaginator $paginator, $full = false)

<!-- Example output: -->
<link rel="prev" href="http://example.com/news/page/2" />
<link rel="next" href="http://example.com/news/page/4" />

测试

该包包含一些使用Orchestra设置的集成/烟雾测试。可以通过phpunit运行测试。

$ phpunit

即将推出

• 支持Bootstrap 4.*的分页渲染。

贡献

有关详细信息，请参阅CONTRIBUTING。

安全

如果您发现任何与安全相关的问题，请通过电子邮件hemarao@prepr.org而不是使用问题跟踪器。

鸣谢

• Sebastian De Deyne
• 所有贡献者

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。