thinkphp 分頁類源碼詳細解讀(帶執行個體解讀)

thinkphp的分頁類是非常常用的一個類，所以特別詳細看了源碼記錄下來，以方便自己隨時複習，這裡的thinkphp是3.23的版本，但不管哪個版本萬變不離其宗，只要搞懂了源碼，換了版本也不會改變本質。

首先把源碼的解讀放上來，不過由於表述能力問題可能沒有那麼清晰。

<?php// +----------------------------------------------------------------------// | ThinkPHP [ WE CAN DO IT JUST THINK IT ]// +----------------------------------------------------------------------// | Copyright (c) 2006-2014 http://thinkphp.cn All rights reserved.// +----------------------------------------------------------------------// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )// +----------------------------------------------------------------------// | Author: 麥當苗兒 <zuojiazi@vip.qq.com> <http://www.zjzit.cn>// +----------------------------------------------------------------------namespace Think;class Page_my{    public $firstRow; // 起始行數    public $listRows; // 列表每頁顯示行數    public $parameter; // 分頁跳轉時要帶的參數    public $totalRows; // 總行數    public $totalPages; // 分頁總頁面數    public $rollPage   = 11;// 分頁欄每頁顯示的頁數public $lastSuffix = true; // 最後一頁是否顯示總頁數    private $p       = 'p'; //分頁參數名    private $url     = ''; //當前連結URL    private $nowPage = 1;   //當前頁數，預設為一// 分頁顯示定製    private $config  = array(        /*頭部顯示總共記錄條數*/        'header' => '<span class="rows">共 %TOTAL_ROW% 條記錄</span>',        /*第一頁樣式*/        'prev'   => '<<',        /*下一頁樣式*/        'next'   => '>>',        /*分頁第一頁*/        'first'  => '1...',        /*分頁顯示最後一頁*/        'last'   => '...%TOTAL_PAGE%',        /*分頁顯示欄數的格式,如果要添加或減少顯示的樣式就改這裡，例如不想顯示尾頁，去掉%END%即可*/        'theme'  => '%FIRST% %UP_PAGE% %LINK_PAGE% %DOWN_PAGE% %END%',    );    /**     * 架構函數     * @param array $totalRows  總的記錄數     * @param array $listRows  每頁顯示記錄數     * @param array $parameter  分頁跳轉的參數     */    public function __construct($totalRows, $listRows=20, $parameter = array()) {        /*檢查分頁參數在config檔案裡是否設定，如果設定了將$p設定額外該參數*/        C('VAR_PAGE') && $this->p = C('VAR_PAGE'); //設定分頁參數名稱        /* 基礎設定 */        $this->totalRows  = $totalRows; //設定總記錄數        $this->listRows   = $listRows;  //設定每頁顯示行數        /*如果$parameter為空白，則取get的參數，否則取設定的參數，        這裡排除了模組控制器方法的get參數，要注意        例如http://localhost/c/ceshi.php?m=Home&c=Index&a=index&ceshi=ceshi這個連結        如果$parameter為空白，$parameter會等於array('ceshi'=>'ceshi')，        如果$parameter設定了，那麼會忽略get參數裡的ceshi，而會採用$parameter設定的參數，        例如$page=new \Think\Page(20,5,array('pa'=>'pa'))，$parameter會等於array('pa'=>'pa');        */        $this->parameter  = empty($parameter) ? $_GET : $parameter;        /*如果get的參數裡$p對應的值為空白，則將本頁取1，否則取$_GET[$p]的整數值賦值給當前頁數$nowPage*/        $this->nowPage    = empty($_GET[$this->p]) ? 1 : intval($_GET[$this->p]);        /*如果$nowpage大於0則取自身，否則取1*/        $this->nowPage    = $this->nowPage>0 ? $this->nowPage : 1;        /*設定每頁第一行的資料為每頁顯示數乘以現在的頁數減一，$listRows*($nowpage-1)*/        $this->firstRow   = $this->listRows * ($this->nowPage - 1);    }    /**     * 定製分頁連結設定     * @param string $name  設定名稱     * @param string $value 設定值     */    public function setConfig($name,$value) {        /*如果$config存在$name的鍵，那麼把$value賦值上去*/        if(isset($this->config[$name])) {            $this->config[$name] = $value;        }    }    /**     * 產生連結URL     * @param  integer $page 頁碼     * @return string     */    private function url($page){        /*將產生的$url裡的urlencode處理過的[PAGE]替換成$page*/        return str_replace(urlencode('[PAGE]'), $page, $this->url);    }    /**     * 組裝分頁連結     * @return string     */    public function show() {        /*如果傳進來的$totalRows是為0返回空值*/        if(0 == $this->totalRows) return '';        /* 產生URL */        /*將$parameter[$p]設定值為[PAGE]*/        $this->parameter[$this->p] = '[PAGE]';        /*把當前對應的控制器方法和參數放入U函數得到當前連結$url        例如$page=new \Think\Page_my(20,5,array('ceshi'=>'ceshi'));        得到的連結會是：/ceshi/ceshi.php/Home/Index/index/ceshi/ceshi/p/%5BPAGE%5D.html        %5BPAGE%5D就是用urlencode處理過的[PAGE]        */        $this->url = U(ACTION_NAME, $this->parameter);        /* 計算分頁資訊 */        /*資料總行數除以每頁顯示的列數然後向上取整得到總頁數*/        $this->totalPages = ceil($this->totalRows / $this->listRows); //總頁數        /*如果總頁數不為空白同時當前頁數大於總頁數，那麼當前頁數為總頁數*/        if(!empty($this->totalPages) && $this->nowPage > $this->totalPages) {            $this->nowPage = $this->totalPages;        }        /* 計算分頁臨時變數 */        $now_cool_page      = $this->rollPage/2;$now_cool_page_ceil = ceil($now_cool_page);        /*如果$lastSuffix設定為true,設定$config['last']=$totalPages也就是總頁數          所以如果想設定頁碼樣式的尾頁樣式的話，需要改動$lastSuffix為false        */$this->lastSuffix && $this->config['last'] = $this->totalPages;        //上一頁        //上一頁頁數        $up_row  = $this->nowPage - 1;        //上一頁的頁碼顯示        //如果上一頁大於0，那麼利用url方法替換得到上一頁$up_row的連結，並處理好樣式        //得到的效果例如<a class="prev" href="ceshi/ceshi.php/Home/Index/Index/index/p/$up_row/parameter/parameter.html"        //如果上一頁不大於0，那麼上一頁的頁碼樣式則為空白值        $up_page = $up_row > 0 ? '<a class="prev" href="' . $this->url($up_row) . '">' . $this->config['prev'] . '</a>' : '';        //下一頁        //下一頁頁數        $down_row  = $this->nowPage + 1;        //如果下一頁頁數小於等於總頁數，那麼利用url方法替換得到下一頁$down_page的連結，並處理好樣式        //如果大於總頁數，那麼下一頁的頁碼樣式則為空白        $down_page = ($down_row <= $this->totalPages) ? '<a class="next" href="' . $this->url($down_row) . '">' . $this->config['next'] . '</a>' : '';        //第一頁        $the_first = '';        /*如果總頁數大於顯示的頁碼數量，        同時當前頁減去顯示的頁碼數量除以2得到的臨時變數後任然大於等於1，        那麼$the_first被賦值第一頁的連結和頁碼以及樣式。        */        if($this->totalPages > $this->rollPage && ($this->nowPage - $now_cool_page) >= 1){            $the_first = '<a class="first" href="' . $this->url(1) . '">' . $this->config['first'] . '</a>';        }        //最後一頁        $the_end = '';        /*如果總頁數大於顯示的頁碼數量，        同時當前頁加上顯示頁碼數量除以2得到的臨時變數小於總頁數        那麼$the_end被賦值最後一頁的連結和頁碼以及樣式。               */        if($this->totalPages > $this->rollPage && ($this->nowPage + $now_cool_page) < $this->totalPages){            $the_end = '<a class="end" href="' . $this->url($this->totalPages) . '">' . $this->config['last'] . '</a>';        }        //數字串連        $link_page = "";        for($i = 1; $i <= $this->rollPage; $i++){            /*如果當前頁碼小於或等於顯示欄數的一半，例如每次顯示1-11頁，            總共11頁，$now_cool_page=5.5,如果當前頁小於5.5的話，頁碼$page=$i*/if(($this->nowPage - $now_cool_page) <= 0 ){$page = $i;            /*如果當前頁加上顯示頁欄的一半的頁數和已經大於總頁數，這種情況例如：總頁數20頁，            當前頁是18頁，如果加上上述假定的1-11頁的顯示欄數的話，18+4.5大於等於20，這種情況下            頁碼等於總頁數-顯示欄數並加上$i*/}elseif(($this->nowPage + $now_cool_page - 1) >= $this->totalPages){$page = $this->totalPages - $this->rollPage + $i;            /*如果沒有滿足上述兩個條件，也就是當前頁既不是靠近開始的頁數，            也不是靠近尾頁的頁數的情況，例如上面20頁，顯示是1-11頁，當前頁是12頁就是這個情況,            當前頁為12時，會從當前頁減去顯示欄的一半向上取整的頁碼開始顯示，也就是從7頁開始顯示，            一直到17頁*/}else{$page = $this->nowPage - $now_cool_page_ceil + $i;}            /*擷取顯示每次顯示的頁碼欄變數$link_page*/            /*如果頁碼大於0且不等於當前頁*/            if($page > 0 && $page != $this->nowPage){                /*如果頁碼小於等於總頁數，將下面添加到顯示頁碼的顯示變數$link_page*/                if($page <= $this->totalPages){                    $link_page .= '<a class="num" href="' . $this->url($page) . '">' . $page . '</a>';                }else{                    break;                }            /*如果頁碼等於當前頁或者小於等於0*/            }else{                /*如果頁碼大於0且總頁數不等於1，將下面添加到顯示頁碼的顯示變數$link_page*/                if($page > 0 && $this->totalPages != 1){                    $link_page .= '<span class="current">' . $page . '</span>';                }            }        }        //替換分頁內容        //將得到的變數根據$config['theme']配置的樣式替換成上面得到的變數值        $page_str = str_replace(            array('%HEADER%', '%NOW_PAGE%', '%UP_PAGE%', '%DOWN_PAGE%', '%FIRST%', '%LINK_PAGE%', '%END%', '%TOTAL_ROW%', '%TOTAL_PAGE%'),            array($this->config['header'], $this->nowPage, $up_page, $down_page, $the_first, $link_page, $the_end, $this->totalRows, $this->totalPages),            $this->config['theme']);        return "<div>{$page_str}</div>";    }}

下面是執行個體運用的解讀，其實我覺得執行個體反而沒有那麼重要，重要的是看懂了源碼，即便沒有執行個體也能很清楚該如何使用了，不過為了更清晰，還是在這裡詳細放幾個執行個體。

下面是執行個體的分頁頁面樣式：

php代碼：

<?phpnamespace Home\Controller;use Think\Controller;class IndexController extends Controller {public function index(){$page=new \Think\Page(200,10);$page->setConfig('first','首頁');$page->setConfig('prev','上一頁');$page->setConfig('next','下一頁');$page->lastSuffix=false;//要想改變最後一頁的樣式，是要設定為false的，不然不會成功，上面的源碼有解讀為什麼會這樣$page->setConfig('last','尾頁');$show=$page->show();$this->assign("page",$show);$this->display('page');}}

html代碼：

<!DOCTYPE html><html><head><meta charset="utf-8"/><title>分頁樣式</title><style type="text/css">*{margin:0 auto;}div{width:100%;height:45px;text-align:center;margin-top:50px;float:left;}span,a{width:auto;height:32px;display:block;background:#fff;border:1px solid #09e;color:#09e;margin:5px;line-height:32px;padding:0px 10px 0px 10px;float:left;border-radius:2px;}a{background:#09e;color:#fff;text-decoration:none;}</style></head><body><div>{$page}</div></body></html>

如果想要改變頁碼的顯示格式，這裡兩個例子，一個是去掉尾頁的顯示，一個是添加總頁數的顯示：

首先來看去掉尾頁的顯示只需要在上面的代碼加上這一條：

$page->setConfig('theme','%FIRST% %UP_PAGE% %LINK_PAGE% %DOWN_PAGE%');

顯示如圖：

下面來看看如何添加總頁數的顯示，其實也是只需要在$config['theme']裡改動即可。

$page->setConfig('header','<span class="rows"> %NOW_PAGE% / %TOTAL_ROW% 條</span>');
$page->setConfig('theme','%FIRST% %UP_PAGE% %LINK_PAGE% %DOWN_PAGE% %END% %HEADER%');

上面我對總頁數的顯示進行了一定的改動，顯示如下：