yii2分頁的使用及其擴展

作者:白狼 出處:http://www.manks.top/yii2_linkpager_pagination.html 本文版權歸作者,歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連接,否則保留追究法律責任的權利。

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

  1. 分頁的使用,一步一步的教你怎麼做

  2. 分頁類LinkPager和Pagination都可以自定義哪些屬性

  3. 分頁類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個按鈕

  1. 首先,我們把上下頁的按鈕修改成中文

<?= LinkPager::widget([ 
    'pagination' => $pages, 
    'nextPageLabel' => '下一頁', 
    'prevPageLabel' => '上一頁', 
]); ?>
  1. 如果你不想要顯示上下頁,可以將prevPageLabel和nextPageLabel設置爲false

<?= LinkPager::widget([ 
    'pagination' => $pages, 
    'nextPageLabel' => false, 
    'prevPageLabel' => false, 
]); ?>
  1. 默認不顯示首頁也尾頁,如果你需要,可以這樣設置

<?= LinkPager::widget([ 
    'pagination' => $pages, 
    'firstPageLabel' => '首頁', 
    'lastPageLabel' => '尾頁', 
]); ?>
  1. 如果你的數據過少,不夠2頁,默認不顯示分頁,如果你需要,設置hideOnSinglePage=false即可

<?= LinkPager::widget([ 
    'pagination' => $pages, 
    'hideOnSinglePage' => false, 
]); ?>
  1. 默認顯示的頁碼爲10頁,可以設置maxButtonCount爲你想要展示的頁數

<?= LinkPager::widget([ 
    'pagination' => $pages, 
    'maxButtonCount' => 5, 
]); ?>
  1. 有些人不喜歡默認的樣式,想要分頁帶上自己的樣式,可以設置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, 
]);
  1. 默認分頁的數量是20,你可以設置pageSize爲你想要的

$pages = new Pagination([ 
    'totalCount' => $totalCount, 
    'pageSize' => 5, 
]);
  1. 從上面的分頁路由我們可以看到,默認帶的有每頁的數量per-page 如果你不想顯示該參數,設置pageSizeParam=false就好

$pages = new Pagination([ 
    'totalCount' => $totalCount, 
    'pageSizeParam' => false, 
]);
  • 我們也可以看到,默認的頁面取決於參數page,如果你想改變該參數爲p,設置pageParam=p就好

$pages = new Pagination([ 
    'totalCount' => $totalCount, 
    'pageParam' => 'p', 
]);
  1. 如果你的分頁存在於首頁,相信你肯定想要/?p=1而不是/site/index?p=1,我們看看怎麼隱藏掉路由

$pages = new Pagination([ 
    'totalCount' => $totalCount, 
    'route' => false, 
]);
  1. 可能你會發現分頁類Pagination有一個bug,假如我們只有1頁的數據,但是手動更改地址欄的page=20的時候,也會顯示page=1的數據?當然,這在大部分接口API中就很讓人厭煩。但是,這並非bug,而是一種友好的驗證。設置validatePage=false即可避免掉該問題

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

最後,我們整點新花樣,擴展下他這個自帶的分頁!

[考慮目前國內網站大部分採集文章十分頻繁,更有甚者不註明原文出處,原作者更希望看客們查看原文,以防有任何問題不能更新所有文章,避免誤導!]

繼續閱讀

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章