PHP框架Laravel插件Pagination实现自定义分页


Posted in PHP onApril 22, 2020

Laravel 的分页很方便,其实扩展起来也挺容易的,下面就来做个示例,扩展一下 paginate() 和 simplePaginate() 方法,来实现我们自定义分页样式,比如显示 "上一页" 和 "下一页" ,而不是 "《" 和 "》" ,当然扩展的方法掌握了你就可以肆无忌惮的扩展一个你想要的分页了,比如跳转到某一页,分页显示一共多少记录,当前显示的记录范围等等巴拉巴拉的。

5.1和5.2应该是同样的方法,我这里用的是5.2的版本。文档告诉我们 Paginator 对应于查询语句构造器和 Eloquent 的  simplePaginate 方法,而  LengthAwarePaginator 则等同于  paginate 方法。那我们还是来看下源码,具体这个  paginate 是如何实现 render() 的,

Illuminate/Pagination/LengthAwarePaginator.php

<?php

namespace Illuminate\Pagination;

......

class LengthAwarePaginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, LengthAwarePaginatorContract 
{
......
 public function render(Presenter $presenter = null)
 {
  if (is_null($presenter) && static::$presenterResolver) {
   $presenter = call_user_func(static::$presenterResolver, $this);
  }

  $presenter = $presenter ?: new BootstrapThreePresenter($this);

  return $presenter->render();
 }
......
}

render() 中传入的是一个 Presenter 的实例,并调用这个实例化的 render 方法来实现分页的显示的。如果没有则调用 BootstrapThreePresenter 中 render() 的,来看看 BootstrapThreePresenter 是干嘛的

Illuminate/Pagination/BootstrapThreePresenter.php

<?php

namespace Illuminate\Pagination;

use Illuminate\Support\HtmlString; 
use Illuminate\Contracts\Pagination\Paginator as PaginatorContract; 
use Illuminate\Contracts\Pagination\Presenter as PresenterContract;

class BootstrapThreePresenter implements PresenterContract 
{
 use BootstrapThreeNextPreviousButtonRendererTrait, UrlWindowPresenterTrait;

 /**
  * The paginator implementation.
  *
  * @var \Illuminate\Contracts\Pagination\Paginator
  */
 protected $paginator;

 /**
  * The URL window data structure.
  *
  * @var array
  */
 protected $window;

 /**
  * Create a new Bootstrap presenter instance.
  *
  * @param \Illuminate\Contracts\Pagination\Paginator $paginator
  * @param \Illuminate\Pagination\UrlWindow|null $window
  * @return void
  */
 public function __construct(PaginatorContract $paginator, UrlWindow $window = null)
 {
  $this->paginator = $paginator;
  $this->window = is_null($window) ? UrlWindow::make($paginator) : $window->get();
 }

 /**
  * Determine if the underlying paginator being presented has pages to show.
  *
  * @return bool
  */
 public function hasPages()
 {
  return $this->paginator->hasPages();
 }

 /**
  * Convert the URL window into Bootstrap HTML.
  *
  * @return \Illuminate\Support\HtmlString
  */
 public function render()
 {
  if ($this->hasPages()) {
   return new HtmlString(sprintf(
    '<ul class="pagination">%s %s %s</ul>',
    $this->getPreviousButton(),
    $this->getLinks(),
    $this->getNextButton()
   ));
  }

  return '';
 }
......
}

这里可以看到 BootstrapThreePresenter 实现了 PresenterContract 的接口, render() 才是分页显示的真正实现,构造方法中的第一个参数 PaginatorContract 其实就是一个 Paginator 我们继续看下 PresenterContract 也就是 Presenter 接口中定义了什么方法需要实现

illuminate/contracts/Pagination/Presenter.php

<?php

namespace Illuminate\Contracts\Pagination;

interface Presenter 
{
 /**
  * Render the given paginator.
  *
  * @return \Illuminate\Contracts\Support\Htmlable|string
  */
 public function render();

 /**
  * Determine if the underlying paginator being presented has pages to show.
  *
  * @return bool
  */
 public function hasPages();
}

其中定义了 render 和 hasPages 方法需要实现

好了,那我们现在已经很清晰了,我们要自定义分页的显示,那么就要写一个我们自己的 Presenter 来实现接口中的 render() 和 hasPages() 就可以了。

首先就来简单的实现一个paginate(),显示出来"上一页"和"下一页",中间是分页数字的例子。

新建文件如下(个人习惯)

app/Foundations/Pagination/CustomerPresenter.php

<?php 
namespace App\Foundations\Pagination;

use Illuminate\Contracts\Pagination\Presenter as PresenterContract; 
use Illuminate\Contracts\Pagination\LengthAwarePaginator as PaginatorContract; 
use Illuminate\Pagination\UrlWindow; 
use Illuminate\Support\HtmlString; 
use Illuminate\Pagination\BootstrapThreeNextPreviousButtonRendererTrait; 
use Illuminate\Pagination\UrlWindowPresenterTrait;

class CustomerPresenter implements PresenterContract 
{
 use BootstrapThreeNextPreviousButtonRendererTrait, UrlWindowPresenterTrait;

 protected $paginator;

 protected $window;

 /**
  * Create a new Bootstrap presenter instance.
  *
  * @param \Illuminate\Contracts\Pagination\Paginator $paginator
  * @param \Illuminate\Pagination\UrlWindow|null $window
  * @return void
  */
 public function __construct(PaginatorContract $paginator, UrlWindow $window = null)
 {
  $this->paginator = $paginator;
  $this->window = is_null($window) ? UrlWindow::make($paginator) : $window->get();
 }

 /**
  * Determine if the underlying paginator being presented has pages to show.
  *
  * @return bool
  */
 public function hasPages()
 {
  return $this->paginator->hasPages();
 }

 /**
  * Convert the URL window into Bootstrap HTML.
  *
  * @return \Illuminate\Support\HtmlString
  */
 public function render()
 {
  if ($this->hasPages()) {
   return new HtmlString(sprintf(
    '<ul class="pagination">%s %s %s</ul>',
    $this->getPreviousButton('上一页'),//具体实现可以查看该方法
    $this->getLinks(),
    $this->getNextButton('下一页')//具体实现可以查看该方法
   ));
  }

  return '';
 }

 /**
  * Get HTML wrapper for an available page link.
  *
  * @param string $url
  * @param int $page
  * @param string|null $rel
  * @return string
  */
 protected function getAvailablePageWrapper($url, $page, $rel = null)
 {
  $rel = is_null($rel) ? '' : ' rel="' . $rel . '"';

  return '<li><a href="' . htmlentities($url) . '"' . $rel . '>' . $page . '</a></li>';
 }

 /**
  * Get HTML wrapper for disabled text.
  *
  * @param string $text
  * @return string
  */
 protected function getDisabledTextWrapper($text)
 {
  return '<li class="disabled hide"><span>' . $text . '</span></li>';
 }

 /**
  * Get HTML wrapper for active text.
  *
  * @param string $text
  * @return string
  */
 protected function getActivePageWrapper($text)
 {
  return '<li class="active"><span>' . $text . '</span></li>';
 }

 /**
  * Get a pagination "dot" element.
  *
  * @return string
  */
 protected function getDots()
 {
  return $this->getDisabledTextWrapper('...');
 }

 /**
  * Get the current page from the paginator.
  *
  * @return int
  */
 protected function currentPage()
 {
  return $this->paginator->currentPage();
 }

 /**
  * Get the last page from the paginator.
  *
  * @return int
  */
 protected function lastPage()
 {
  return $this->paginator->lastPage();
 }

}

就这么简单,主要就是 render() 方法,如果项目中需要修改分页样式,或者添加分页跳转之类的需求只要重写其中的各项显示的方法中的html元素就可以了,很灵活,在blade模板中也需要修该,比如我们的 Paginator 叫 $users ,默认的分页显示是这样的:

{!! $users->render() !!}
修改成我们自定义后的分页显示:

{!! with(new \App\Foundations\Pagination\CustomerPresenter($categories))->render() !!}
好了,这样在页面应该就可以看到分页链接中含有 "上一页"和"下一页"加数字的样式了。

那么如果扩展simplePaginate?其实很简单,只要继承刚才的 CustomerPresenter ,实现 hasPages 和 render ,至于为什么可以按照我上面查看源码的方式看一下就知道了,比如我们改成"上一篇"和"下一篇"

新建App\Foundations\Pagination\CustomerSimplePresenter.php

<?php 
namespace App\Foundations\Pagination;


use Illuminate\Support\HtmlString; 
use Illuminate\Contracts\Pagination\Paginator as PaginatorContract;

class CustomerSimplePresenter extends CustomerPresenter 
{
 /**
  * Create a simple Bootstrap 3 presenter.
  *
  * @param \Illuminate\Contracts\Pagination\Paginator $paginator
  * @return void
  */
 public function __construct(PaginatorContract $paginator)
 {
  $this->paginator = $paginator;
 }

 /**
  * Determine if the underlying paginator being presented has pages to show.
  *
  * @return bool
  */
 public function hasPages()
 {
  return $this->paginator->hasPages() && count($this->paginator->items()) > 0;
 }

 /**
  * Convert the URL window into Bootstrap HTML.
  *
  * @return \Illuminate\Support\HtmlString
  */
 public function render()
 {
  if ($this->hasPages()) {
   return new HtmlString(sprintf(
    '<ul class="pager">%s %s</ul>',
    $this->getPreviousButton('上一篇'),
    $this->getNextButton('下一篇')
   ));
  }

  return '';
 }

}

分页显示:

{!! with(new \App\Foundations\Pagination\CustomerSimplePresenter($categories))->render() !!}

方法就是这个方法,具体修改按照自己需求重写其中对应的显示html元素的方法就可以了。

转载请注明:转载自 Ryan是菜鸟 | LNMP技术栈笔记

以上就是本文的全部内容,希望对大家学习PHP程序设计有所帮助。

PHP 相关文章推荐
php中session_unset与session_destroy的区别分析
Jun 16 PHP
PHP 修复未正常关闭的HTML标签实现代码(支持嵌套和就近闭合)
Jun 07 PHP
在yii中新增一个用户验证的方法详解
Jun 20 PHP
php实现的Timer页面运行时间监测类
Sep 24 PHP
php实现上传图片保存到数据库的方法
Feb 11 PHP
WordPress中给媒体文件添加分类和标签的PHP功能实现
Dec 31 PHP
php each 返回数组中当前的键值对并将数组指针向前移动一步实例
Nov 22 PHP
thinkPHP5.0框架模块设计详解
Mar 18 PHP
在Laravel中使用DataTables插件的方法
May 29 PHP
PHP自定义错误处理的方法分析
Dec 19 PHP
php array_chunk()函数用法与注意事项
Jul 12 PHP
tp5框架无刷新分页实现方法分析
Sep 26 PHP
屏蔽PHP默认设置中的Notice警告的方法
May 20 #PHP
PHP获取网站中各文章的第一张图片的代码示例
May 20 #PHP
今天你说520了吗?不仅有php表白书还有java表白神器
May 20 #PHP
程序员的表白神器“520”大声喊出来
May 20 #PHP
PHP性能优化大全(php.ini)
May 20 #PHP
自定义min版smarty模板引擎MinSmarty.class.php文件及用法
May 20 #PHP
smarty自定义函数用法示例
May 20 #PHP
You might like
《PHP编程最快明白》第四讲:日期、表单接收、session、cookie
2010/11/01 PHP
php获取json数据所有的节点路径
2015/05/17 PHP
thinkphp微信开发(消息加密解密)
2015/12/02 PHP
利用php做服务器和web前端的界面进行交互
2016/10/31 PHP
通过javascript的匿名函数来分析几段简单有趣的代码
2010/06/29 Javascript
jquery统计复选框选中示例
2013/11/05 Javascript
js加入收藏夹代码(兼容ie/ff/op)
2014/05/16 Javascript
初识Node.js
2015/03/20 Javascript
原生js jquery ajax请求以及jsonp的调用方法
2017/08/04 jQuery
JS尾递归的实现方法及代码优化技巧
2019/01/19 Javascript
微信小程序 select 下拉框组件功能
2019/09/09 Javascript
js实现滚动条自动滚动
2020/12/13 Javascript
Django中使用locals()函数的技巧
2015/07/16 Python
解决Python传递中文参数的问题
2015/08/04 Python
python3.5仿微软计算器程序
2020/03/30 Python
python3制作捧腹网段子页爬虫
2017/02/12 Python
开源Web应用框架Django图文教程
2017/03/09 Python
matplotlib在python上绘制3D散点图实例详解
2017/12/09 Python
基于Python3.6+splinter实现自动抢火车票
2018/09/25 Python
flask session组件的使用示例
2018/12/25 Python
对python中词典的values值的修改或新增KEY详解
2019/01/20 Python
详解将Python程序(.py)转换为Windows可执行文件(.exe)
2019/07/19 Python
python安装后的目录在哪里
2020/06/21 Python
使用Python操作MySQL的小技巧
2020/09/10 Python
H&M美国官网:欧洲最大的服饰零售商
2016/09/07 全球购物
湖南卫视在线视频媒体平台:芒果TV
2019/10/30 全球购物
Fox Racing官方网站:越野摩托车和山地自行车装备和服装
2019/12/23 全球购物
介绍一下游标
2012/01/10 面试题
internal修饰符起什么作用
2013/12/16 面试题
医药工作者的求职信范文
2013/09/21 职场文书
元宵节晚会主持人串词
2014/03/25 职场文书
中学生励志演讲稿
2014/04/26 职场文书
工程材料采购方案
2014/05/18 职场文书
幼儿园清明节活动总结
2014/07/04 职场文书
民主评议党员总结
2014/10/20 职场文书
springcloud之Feign超时问题的解决
2021/06/24 Java/Android