Home » Documentation » Class Reference » CPagination

CPagination

Package	system.web
Inheritance	class CPagination » CComponent
Since	1.0
Version	$Id: CPagination.php 2236 2010-07-01 11:54:23Z alexander.makarow $

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 = Post::model()->findAll($criteria);

    $this->render('index', array(
    'models' => $models,
         'pages' => $pages
    ));
}

View:


    // display a model


// display pagination
widget('CLinkPager', array(
    'pages' => $pages,
))?>

Public Properties

Hide inherited 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	the additional GET parameters (name=>value) that should be used when generating pagination URLs.	CPagination
route	string	the route (controller ID and action ID) for displaying the paged contents.	CPagination

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CPagination
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
applyLimit()	Applies LIMIT and OFFSET to the specified query criteria.	CPagination
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
createPageUrl()	Creates the URL suitable for pagination.	CPagination
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getCurrentPage()		CPagination
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getItemCount()		CPagination
getLimit()		CPagination
getOffset()		CPagination
getPageCount()		CPagination
getPageSize()		CPagination
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
raiseEvent()	Raises an event.	CComponent
setCurrentPage()		CPagination
setItemCount()		CPagination
setPageSize()		CPagination

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 (available since v1.0.9)

public array $params;

the additional GET parameters (name=>value) that should be used 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.

Method Details

__construct() method (available since v1.0.1)

public void __construct(integer $itemCount=0)
$itemCount	integer	total number of items.

Constructor.

applyLimit() method (available since v1.0.1)

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.

createPageUrl() method

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

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)
$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.

getItemCount() method

public integer getItemCount()
{return}	integer	total number of items. Defaults to 0.

getLimit() method (available since v1.1.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.

getOffset() method (available since v1.1.0)

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.

getPageCount() method

public integer getPageCount()
{return}	integer	number of pages

getPageSize() method

public integer getPageSize()
{return}	integer	number of items in each page. Defaults to 10.

setCurrentPage() method

public void setCurrentPage(integer $value)
$value	integer	the zero-based index of the current page.

setItemCount() method

public void setItemCount(integer $value)
$value	integer	total number of items.

setPageSize() method

public void setPageSize(integer $value)
$value	integer	number of items in each page

Total 1 comment:

#1794

Pagination And The Browser Back Button

by thinkingspace at 8:48am on August 14, 2010.

There can be a problem with the CListView, CPagination default functionality. If you page forward to say page three, then look at a detail view from that page (i.e. drill down), the average user would expect the browser back button to return them to page three. However, because the pagination has been handled by Ajax they are taken to page one. This is not al all user friendly. The simple solution is to disbale Ajax by adding to the CListView the line: 'ajaxUpdate'=>false, Are there better solutions to this?