Yii2分页的使用及其扩展方法详解


Posted in PHP onMay 23, 2016

前言:

说明下我们本篇文章都要讲哪些内容

分页的使用,一步一步的教你怎么做

分页类LinkPager和Pagination都可以自定义哪些属性

分页类LinkPager如何扩展成我们所需要的

第一步,我们来看看yii2自带的分页类该如何去使用?

1、controller action

use yii\data\Pagination;
$query = Article::find()->where(['status' => 1]);
$countQuery = clone $query;
$pages = new Pagination(['totalCount' => $countQuery->count()]);
$models = $query->offset($pages->offset)
  ->limit($pages->limit)
  ->all();
return $this->render('index', [
  'models' => $models,
  'pages' => $pages,
]);

2、View

use yii\widgets\LinkPager;
//循环展示数据
foreach ($models as $model) {
  // ......
}
//显示分页页码
echo LinkPager::widget([
  'pagination' => $pages,
])

代码基本上可以完全拷贝,修改部分数据即可,相信大多数人都是看得懂的。

我们接下来看第二步,自带的分页类都可以定义哪些属性

首先我们说说LinkPager组件

.pagination参数必填,这个是我们Pagination类的实例

默认分页类是下面这个样子的

 Yii2分页的使用及其扩展方法详解

.上下页按钮以及10个按钮

首先,我们把上下页的按钮修改成中文

<?= LinkPager::widget([ 
  'pagination' => $pages, 
  'nextPageLabel' => '下一页', 
  'prevPageLabel' => '上一页', 
]); ?>

如果你不想要显示上下页,可以将prevPageLabel和nextPageLabel设置为false

<?= LinkPager::widget([ 
  'pagination' => $pages, 
  'nextPageLabel' => false, 
  'prevPageLabel' => false, 
]); ?>

默认不显示首页也尾页,如果你需要,可以这样设置

<?= LinkPager::widget([ 
  'pagination' => $pages, 
  'firstPageLabel' => '首页', 
  'lastPageLabel' => '尾页', 
]); ?>

如果你的数据过少,不够2页,默认不显示分页,如果你需要,设置hideOnSinglePage=false即可

<?= LinkPager::widget([ 
  'pagination' => $pages, 
  'hideOnSinglePage' => false, 
]); ?>

默认显示的页码为10页,可以设置maxButtonCount为你想要展示的页数

<?= LinkPager::widget([ 
  'pagination' => $pages, 
  'maxButtonCount' => 5, 
]); ?>

有些人不喜欢默认的样式,想要分页带上自己的样式,可以设置options,不要忘了自行实现pre,next,disabled等样式

<?= LinkPager::widget([ 
  'pagination' => $pages, 
  'options' => ['class' => 'm-pagination'], 
]); ?>

接下来我们谈谈Pagination组件

默认的分页路由是下面这样子的,我们看看能做点什么

/controller/action?page=2&per-page=20

首先,我们是必须要指定总条数totalCount的,没这个参数,分页也是没办法实现的

$pages = new Pagination([ 
  'totalCount' => $totalCount, 
]);

默认分页的数量是20,你可以设置pageSize为你想要的

$pages = new Pagination([ 
  'totalCount' => $totalCount, 
  'pageSize' => 5, 
]);

从上面的分页路由我们可以看到,默认带的有每页的数量per-page 如果你不想显示该参数,设置pageSizeParam=false就好

$pages = new Pagination([ 
  'totalCount' => $totalCount, 
  'pageSizeParam' => false, 
]);

我们也可以看到,默认的页面取决于参数page,如果你想改变该参数为p,设置pageParam=p就好

$pages = new Pagination([ 
  'totalCount' => $totalCount, 
  'pageParam' => 'p', 
]);

如果你的分页存在于首页,相信你肯定想要/?p=1而不是/site/index?p=1,我们看看怎么隐藏掉路由

$pages = new Pagination([ 
  'totalCount' => $totalCount, 
  'route' => false, 
]);

可能你会发现分页类Pagination有一个bug,假如我们只有1页的数据,但是手动更改地址栏的page=20的时候,也会显示page=1的数据?当然,这在大部分接口API中就很让人厌烦。但是,这并非bug,而是一种友好的验证。设置validatePage=false即可避免掉该问题

$pages = new Pagination([ 
  'totalCount' => $totalCount, 
  'validatePage' => false, ]);

最后,我们整点新花样,扩展下他这个自带的分页!别一看见扩展俩字下面的就直接不看了,只有自己学会扩展了,以后才能越来越强!怎么个扩展法呢?我们把分页组件改为上下页那种,具体参考下图做个对比吧

Yii2分页的使用及其扩展方法详解

接下来我们就来看看右侧的效果具体是如何通过扩展LinkPager组件实现的。源码分享给大家,喜欢的拿去自己研究即可。

<?php
namespace frontend\components;
use yii\widgets\LinkPager;
use yii\helpers\Html;
class MLinkPager extends LinkPager
{
  public $prevPageLabel = '<i class="fa fa-angle-left"></i>';
  public $nextPageLabel = '<i class="fa fa-angle-right"></i>';
  public $currentCountPageLabel = '第 {currentPage} 页 / 共 {countPage} 页';
  public $currentCountPageClass = 'page-number';
  public $hideOnSinglePage = false;
  public function init () {
    parent::init();
  }
  public function run () {
    $pageCount = $this->pagination->getPageCount();
    if ($pageCount < 2 && $this->hideOnSinglePage) {
      return '';
    }
    $buttons = [];
    $currentPage = $this->pagination->getPage();
    // prev page
    if ($this->prevPageLabel !== false) {
      if (($page = $currentPage - 1) < 0) {
        $page = 0;
      }
      $buttons[] = $this->renderPageButton($this->prevPageLabel, $page, $this->prevPageCssClass, $currentPage <= 0, false);
    }
    // current page / count page
    if ($this->currentCountPageLabel !== false && $pageCount) {
      $currentCountPageLabel = str_replace(['{currentPage}', '{countPage}'], [$currentPage+1, $pageCount], $this->currentCountPageLabel);
      $buttons[] = Html::tag('span', $currentCountPageLabel, array('class' => $this->currentCountPageClass));
    }
    // next page
    if ($this->nextPageLabel !== false) {
      if (($page = $currentPage + 1) >= $pageCount - 1) {
        $page = $pageCount - 1;
      }
      $buttons[] = $this->renderPageButton($this->nextPageLabel, $page, $this->nextPageCssClass, $currentPage >= $pageCount - 1, false);
    }
    return Html::tag('nav', implode("\n", $buttons), $this->options);
  }
  protected function renderPageButton($label, $page, $class, $disabled, $active)
  {
    $options = ['class' => empty($class) ? $this->pageCssClass : $class];
    if ($active) {
      Html::addCssClass($options, $this->activePageCssClass);
    }
    if ($disabled) {
      return false;
    }
    $linkOptions = $this->linkOptions;
    $linkOptions += $options;
    $linkOptions['data-page'] = $page;
    return Html::a($label, $this->pagination->createUrl($page), $linkOptions);
  }
}

如此一来,我们调用MLinkPager实现分页效果像下面这样即可

use frontend\components\MLinkPager; 
<?= MLinkPager::widget([ 
  'pagination' => $pages, 
]); ?>

当然,自己扩展的分页组建重在教大家如何去实现分页扩展,难免会有很多问题,如果你有好的意见或者方法,直接给我留言,咱们共同沟通交流。

PHP 相关文章推荐
PHP在Web开发领域的优势
Oct 09 PHP
php生成文件
Jan 15 PHP
php array_flip() 删除数组重复元素
Jan 14 PHP
PHP $_SERVER详解
Jan 16 PHP
PHPwind整合最土系统用户同步登录实现方法
Dec 08 PHP
smarty模板局部缓存方法使用示例
Jun 17 PHP
php实现删除指定目录下相关文件的方法
Oct 20 PHP
PHP使用PHPExcel删除Excel单元格指定列的方法
Jul 06 PHP
PHP微信分享开发详解
Jan 14 PHP
PHP实现webshell扫描文件木马的方法
Jul 31 PHP
PHP数据库操作四:mongodb用法分析
Aug 16 PHP
PHP使用PDO创建MySQL数据库、表及插入多条数据操作示例
May 30 PHP
CI框架扩展系统核心类的方法分析
May 23 #PHP
PHP strip_tags保留多个HTML标签的方法
May 22 #PHP
项目中应用Redis+Php的场景
May 22 #PHP
Yii2.0 模态弹出框+ajax提交表单
May 22 #PHP
php文件上传后端处理小技巧
May 22 #PHP
PHP strip_tags() 去字符串中的 HTML、XML 以及 PHP 标签的函数
May 22 #PHP
PHP+MySql+jQuery实现的&quot;顶&quot;和&quot;踩&quot;投票功能
May 21 #PHP
You might like
Yii使用Captcha验证码的方法
2015/12/28 PHP
PHP字符串逆序排列实现方法小结【strrev函数,二分法,循环法,递归法】
2017/01/13 PHP
浅谈ThinkPHP5.0版本和ThinkPHP3.2版本的区别
2017/06/17 PHP
Yii2框架操作数据库的方法分析【以mysql为例】
2019/05/27 PHP
去除链接虚线全面分析总结
2006/08/15 Javascript
JS 文件本身编码转换 图文教程
2009/10/12 Javascript
一个简单的js渐显(fadeIn)渐隐(fadeOut)类
2010/06/19 Javascript
原生javascript实现图片轮播效果代码
2010/09/03 Javascript
动态的改变IFrame的高度实现IFrame自动伸展适应高度
2012/12/28 Javascript
JS实现三级折叠菜单特效,其它级可自动收缩
2015/08/06 Javascript
Javascript HTML5 Canvas实现的一个画板
2020/04/12 Javascript
JavaScript基于原型链的继承
2016/06/22 Javascript
BootStrapTable服务器分页实例解析
2016/12/20 Javascript
详解Angular2 之 结构型指令
2017/06/21 Javascript
vue2.x+webpack快速搭建前端项目框架详解
2017/11/30 Javascript
zTree 树插件实现全国五级地区点击后加载的示例
2018/02/05 Javascript
使用Vue实现图片上传的三种方式
2018/07/17 Javascript
Vue使用NProgress进度条的方法
2019/09/21 Javascript
javascript数组的定义及操作实例
2019/11/10 Javascript
js HTML DOM EventListener功能与用法实例分析
2020/04/27 Javascript
如何实现js拖拽效果及原理解析
2020/05/08 Javascript
基于Vue全局组件与局部组件的区别说明
2020/08/11 Javascript
Vue SPA 首屏优化方案
2021/02/26 Vue.js
[02:48]DOTA2超级联赛专访海涛:你们的选择没有错
2013/06/07 DOTA
Python入门之modf()方法的使用
2015/05/15 Python
Django项目中包含多个应用时对url的配置方法
2018/05/30 Python
代码总结Python2 和 Python3 字符串的区别
2020/01/28 Python
手把手教你进行Python虚拟环境配置教程
2020/02/03 Python
python文件读取失败怎么处理
2020/06/23 Python
Python HTMLTestRunner如何下载生成报告
2020/09/04 Python
在vscode中启动conda虚拟环境的思路详解
2020/12/25 Python
python中编写函数并调用的知识点总结
2021/01/13 Python
matplotlib部件之套索Lasso的使用
2021/02/24 Python
综合实践活动总结
2014/05/05 职场文书
党员干部廉政承诺书
2015/04/28 职场文书
签证扫盲贴,41个常见签证知识,需要的拿走
2019/08/09 职场文书