前言：

說明下我們本篇文章都要講哪些內容

分頁的使用，一步一步的教你怎么做

分頁類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類的實例

默認分頁類是下面這個樣子的

.上下頁按鈕以及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, ]);

最后，我們整點新花樣，擴展下他這個自帶的分頁！別一看見擴展倆字下面的就直接不看了，只有自己學會擴展了，以后才能越來越強！怎么個擴展法呢？我們把分頁組件改為上下頁那種，具體參考下圖做個對比吧

接下來我們就來看看右側的效果具體是如何通過擴展LinkPager組件實現的。源碼分享給大家，喜歡的拿去自己研究即可。

namespace frontend\components;

use yii\widgets\LinkPager;

use yii\helpers\Html;

class MLinkPager extends LinkPager

{

public $prevPageLabel = '';

public $nextPageLabel = '';

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 yii 控件分页,Yii2分页的使用及其扩展方法详解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。