yii2分页知识整理

先从yii2自带的分页开始整理吧！

1 、一种是使用gridview时的常用写法，简单省时

控制器：

public function actionIndex(){
   $where = [
      'and',
      ['=','status',Product::STATUS_NORMAL],
      ['=','type',1],
   ];
   $model= new ActiveDataProvider([
      'query' => Product::find()->orderBy('id desc')->where($where),
      'pagination' => [
         'pageSize' => 10,
      ],
   ]);
   return $this->render('index',[
      'model' => $model,
   ]);
}

视图：

use yii\grid\GridView;
<?php echo GridView::widget([
        'dataProvider' => $model,
        'layout' => "{items}\n{pager}",
        'filterSelector' => "input[name='".$model->getPagination()->pageParam."']",
        'pager' => [
            'class' => LinkPager::className(),
            'firstPageLabel' => '第一页',
            'lastPageLabel' => '最后一页',
            'prevPageLabel' => '上一页',
            'nextPageLabel' => '下一页',
        ],
    'columns' => [
        'id',
       ...
        ],
    ]);
?>

2、第二种是自己封装分页方法，灵活易用

控制器：

public function getCount($where=[]) {
    return self::find()->where($where)->count();
}

public function getCreateQuery($where=[], $limit=20, $sort='id desc',$field='*') {
        return self::find()
            ->where($where)
            ->select($field)
            ->orderBy($sort)
            ->limit($limit);
 }
    
public function getPageList($where=[], $limit=20, $sort='id desc',$field='*') {
    $result['count'] = $this->getCount($where);
    $result['page'] = new \yii\data\Pagination([
        'defaultPageSize' => $limit,
        'totalCount' => $result['count'],
    ]);
    $result['list'] = $this->getCreateQuery($where, $result['page']->limit, $sort,$field)
        ->offset($result['page']->offset)
        ->all();
    return $result;
}

视图：

use yii\widgets\LinkPager;
//循环展示数据
<?php foreach ($newOrderList as $key=>$val):?>
    // ......
<?php endforeach;?>
//显示分页页码
<?= LinkPager::widget([
    'pagination' => $page,
    'maxButtonCount' => 2,//自定义显示的页数
    'firstPageLabel' => '首页',
    'lastPageLabel' => '末页',
    'prevPageLabel' => '上一页',
    'nextPageLabel' => '下一页',
])
?>

代码基本上可以完全拷贝，修改部分数据即可。

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

首先我们说说LinkPager组件

• pagination参数必填，这个是我们Pagination类的实例

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

• 上下页按钮以及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中有关分页的知识，目前了解到的差不多就这些，后面的介绍有借鉴的别人的，在这里说声谢谢！有新的知识点，我会及时更新！