thinkphp 分页类源码详细解读(带实例解读)
thinkphp的分页类是非常常用的一个类，所以特别详细看了源码记录下来，以方便自己随时复习，这里的thinkphp是3.23的版本，但不管哪个版本万变不离其宗，只要搞懂了源码，换了版本也不会改变本质。
首先把源码的解读放上来，不过由于表述能力问题可能没有那么清晰。
// +----------------------------------------------------------------------
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' => '共 %TOTAL_ROW% 条记录',
/*第一页样式*/
'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的链接，并处理好样式
//得到的效果例如 0 ? '' . $this->config['prev'] . '' : '';
//下一页
//下一页页数
$down_row = $this->nowPage + 1;
//如果下一页页数小于等于总页数，那么利用url方法替换得到下一页$down_page的链接，并处理好样式
//如果大于总页数，那么下一页的页码样式则为空
$down_page = ($down_row <= $this->totalPages) ? '' . $this->config['next'] . '' : '';
//第一页
$the_first = '';
/*如果总页数大于显示的页码数量，
同时当前页减去显示的页码数量除以2得到的临时变量后任然大于等于1，
那么$the_first被赋值第一页的链接和页码以及样式。
*/
if($this->totalPages > $this->rollPage && ($this->nowPage - $now_cool_page) >= 1){
$the_first = '' . $this->config['first'] . '';
}
//最后一页
$the_end = '';
/*如果总页数大于显示的页码数量，
同时当前页加上显示页码数量除以2得到的临时变量小于总页数
那么$the_end被赋值最后一页的链接和页码以及样式。
*/
if($this->totalPages > $this->rollPage && ($this->nowPage + $now_cool_page) < $this->totalPages){
$the_end = '' . $this->config['last'] . '';
}
//数字连接
$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 .= '' . $page . '';
}else{
break;
}
/*如果页码等于当前页或者小于等于0*/
}else{
/*如果页码大于0且总页数不等于1，将下面添加到显示页码的显示变量$link_page*/
if($page > 0 && $this->totalPages != 1){
$link_page .= '' . $page . '';
}
}
}
//替换分页内容
//将得到的变量根据$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 "{$page_str}";
}
} 下面是实例的分页页面样式：
php代码：
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代码：
分页样式
{$page}
如果想要改变页码的显示格式，这里两个例子，一个是去掉尾页的显示，一个是添加总页数的显示：
首先来看去掉尾页的显示只需要在上面的代码加上这一条：
$page->setConfig('theme','%FIRST% %UP_PAGE% %LINK_PAGE% %DOWN_PAGE%');
显示如图：
下面来看看如何添加总页数的显示，其实也是只需要在$config['theme']里改动即可。
$page->setConfig('header',' %NOW_PAGE% / %TOTAL_ROW% 条');
$page->setConfig('theme','%FIRST% %UP_PAGE% %LINK_PAGE% %DOWN_PAGE% %END% %HEADER%');
上面我对总页数的显示进行了一定的改动，显示如下：
