CPagination
CPagination represents information relevant to pagination.
When data needs to be rendered in multiple pages, we can use CPagination to represent information such as
total item count,
page size,
current page, etc. These information can be passed to
pagers to render pagination buttons or links.
Example:
Controller action:
function actionIndex(){
$criteria=new CDbCriteria();
$count=Article::model()->count($criteria);
$pages=new CPagination($count);
// results per page
$pages->pageSize=10;
$pages->applyLimit($criteria);
$models=Article::model()->findAll($criteria);
$this->render('index', array(
'models' => $models,
'pages' => $pages
));
}
View:
<?php foreach($models as $model): ?>
// display a model
<?php endforeach; ?>
// display pagination
<?php $this->widget('CLinkPager', array(
'pages' => $pages,
)) ?>
Public Properties
Property |
Type |
Description |
Defined By |
currentPage | integer | the zero-based index of the current page. | CPagination |
itemCount | integer | total number of items. | CPagination |
limit | integer | the limit of the data. | CPagination |
offset | integer | the offset of the data. | CPagination |
pageCount | integer | number of pages | CPagination |
pageSize | integer | number of items in each page. | CPagination |
pageVar | string | name of the GET variable storing the current page index. | CPagination |
params | array | of parameters (name=>value) that should be used instead of GET when generating pagination URLs. | CPagination |
route | string | the route (controller ID and action ID) for displaying the paged contents. | CPagination |
validateCurrentPage | boolean | whether to ensure currentPage is returning a valid page number. | CPagination |
Property Details
public integer getCurrentPage(boolean $recalculate=true)
public void setCurrentPage(integer $value)
the zero-based index of the current page. Defaults to 0.
public integer getItemCount()
public void setItemCount(integer $value)
total number of items. Defaults to 0.
public integer getLimit()
the limit of the data. This may be used to set the LIMIT value for a SQL statement for fetching the current page of data. This returns the same value as pageSize.
public integer getOffset()
the offset of the data. This may be used to set the OFFSET value for a SQL statement for fetching the current page of data.
public integer getPageCount()
number of pages
public integer getPageSize()
public void setPageSize(integer $value)
number of items in each page. Defaults to 10.
public string $pageVar;
name of the GET variable storing the current page index. Defaults to 'page'.
public array $params;
of parameters (name=>value) that should be used instead of GET when generating pagination URLs. Defaults to null, meaning using the currently available GET parameters.
public string $route;
the route (controller ID and action ID) for displaying the paged contents. Defaults to empty string, meaning using the current route.
public boolean $validateCurrentPage;
whether to ensure currentPage is returning a valid page number. When this property is true, the value returned by currentPage will always be between 0 and (pageCount-1). Because pageCount relies on the correct value of itemCount, it means you must have knowledge about the total number of data items when you want to access currentPage. This is fine for SQL-based queries, but may not be feasible for other kinds of queries (e.g. MongoDB). In those cases, you may set this property to be false to skip the validation (you may need to validate yourself then). Defaults to true.
Method Details
public void __construct(integer $itemCount=0) |
$itemCount | integer | total number of items. |
Constructor.
public void applyLimit(CDbCriteria $criteria) |
$criteria | CDbCriteria | the query criteria that should be applied with the limit |
Applies LIMIT and OFFSET to the specified query criteria.
public string createPageUrl(CController $controller, integer $page) |
$controller | CController | the controller that will create the actual URL |
$page | integer | the page that the URL should point to. This is a zero-based index. |
{return} | string | the created URL |
Source Code: framework/web/CPagination.php#200 (
show)
public function createPageUrl($controller,$page)
{
$params=$this->params===null ? $_GET : $this->params;
if($page>0) // page 0 is the default
$params[$this->pageVar]=$page+1;
else
unset($params[$this->pageVar]);
return $controller->createUrl($this->route,$params);
}
Creates the URL suitable for pagination. This method is mainly called by pagers when creating URLs used to perform pagination. The default implementation is to call the controller's createUrl method with the page information. You may override this method if your URL scheme is not the same as the one supported by the controller's createUrl method.
public integer getCurrentPage(boolean $recalculate=true) |
$recalculate | boolean | whether to recalculate the current page based on the page size and item count. |
{return} | integer | the zero-based index of the current page. Defaults to 0. |
Source Code: framework/web/CPagination.php#158 (
show)
public function getCurrentPage($recalculate=true)
{
if($this->_currentPage===null || $recalculate)
{
if(isset($_GET[$this->pageVar]))
{
$this->_currentPage=(int)$_GET[$this->pageVar]-1;
if($this->validateCurrentPage)
{
$pageCount=$this->getPageCount();
if($this->_currentPage>=$pageCount)
$this->_currentPage=$pageCount-1;
}
if($this->_currentPage<0)
$this->_currentPage=0;
}
else
$this->_currentPage=0;
}
return $this->_currentPage;
}
public integer getItemCount() |
{return} | integer | total number of items. Defaults to 0. |
public integer getLimit() |
{return} | integer | the limit of the data. This may be used to set the LIMIT value for a SQL statement for fetching the current page of data. This returns the same value as pageSize. |
public integer getOffset() |
{return} | integer | the offset of the data. This may be used to set the OFFSET value for a SQL statement for fetching the current page of data. |
public integer getPageCount() |
{return} | integer | number of pages |
public integer getPageSize() |
{return} | integer | number of items in each page. Defaults to 10. |
public void setCurrentPage(integer $value) |
$value | integer | the zero-based index of the current page. |
public void setItemCount(integer $value) |
$value | integer | total number of items. |
public void setPageSize(integer $value) |
$value | integer | number of items in each page |