CPagination

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
    ));
}

<?php foreach($models as $model): ?>
    // display a model
<?php endforeach; ?>

// display pagination
<?php $this->widget('CLinkPager', array(
    'pages' => $pages,
)) ?>

Property Details

currentPage property

public integer getCurrentPage(boolean $recalculate=true)
public void setCurrentPage(integer $value)

the zero-based index of the current page. Defaults to 0.

itemCount property

public integer getItemCount()
public void setItemCount(integer $value)

total number of items. Defaults to 0.

limit property read-only (available since v1.1.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.

offset property read-only (available since v1.1.0)

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.

pageCount property read-only

public integer getPageCount()

number of pages

pageSize property

public integer getPageSize()
public void setPageSize(integer $value)

number of items in each page. Defaults to 10.

pageVar property

public string $pageVar;

name of the GET variable storing the current page index. Defaults to 'page'.

params property

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.

route property

public string $route;

the route (controller ID and action ID) for displaying the paged contents. Defaults to empty string, meaning using the current route.

validateCurrentPage property (available since v1.1.4)

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

__construct() method

public void __construct(integer $itemCount=0)

public function __construct($itemCount=0)
{
    $this->setItemCount($itemCount);
}

Constructor.

applyLimit() method

public void applyLimit(CDbCriteria $criteria)

public function applyLimit($criteria)
{
    $criteria->limit=$this->getLimit();
    $criteria->offset=$this->getOffset();
}

Applies LIMIT and OFFSET to the specified query criteria.

createPageUrl() method

public string createPageUrl(CController $controller, integer $page)

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.

getCurrentPage() method

public integer getCurrentPage(boolean $recalculate=true)

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;
}

getItemCount() method

public integer getItemCount()

public function getItemCount()
{
    return $this->_itemCount;
}

getLimit() method (available since v1.1.0)

public integer getLimit()

public function getLimit()
{
    return $this->getPageSize();
}

getOffset() method (available since v1.1.0)

public integer getOffset()

public function getOffset()
{
    return $this->getCurrentPage()*$this->getPageSize();
}

getPageCount() method

public integer getPageCount()

public function getPageCount()
{
    return (int)(($this->_itemCount+$this->_pageSize-1)/$this->_pageSize);
}

getPageSize() method

public integer getPageSize()

public function getPageSize()
{
    return $this->_pageSize;
}

setCurrentPage() method

public void setCurrentPage(integer $value)

public function setCurrentPage($value)
{
    $this->_currentPage=$value;
    $_GET[$this->pageVar]=$value+1;
}

setItemCount() method

public void setItemCount(integer $value)

public function setItemCount($value)
{
    if(($this->_itemCount=$value)<0)
        $this->_itemCount=0;
}

setPageSize() method

public void setPageSize(integer $value)

public function setPageSize($value)
{
    if(($this->_pageSize=$value)<=0)
        $this->_pageSize=self::DEFAULT_PAGE_SIZE;
}