Class CBasePager

CBasePager is the base class for all pagers.

It provides the calculation of page count and maintains the current page.

CComponent

CBaseController

CWidget

CBasePager

Direct known subclasses

CLinkPager, CListPager

Indirect known subclasses

MobileRecordIndexPager, MobileTopicsPager

Abstract
Package: system\web\widgets\pagers
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/widgets/pagers/CBasePager.php

Methods summary
`public CPagination`	# `getPages( )` Returns the pagination information used by this pager. Returns the pagination information used by this pager. Returns `CPagination` the pagination information
`public`	# `setPages( CPagination $pages )` Sets the pagination information used by this pager. Sets the pagination information used by this pager. Parameters `$pages` `CPagination` $pages the pagination information
`protected CPagination`	# `createPages( )` Creates the default pagination. This is called by `CBasePager::getPages()` when the pagination is not set before. Creates the default pagination. This is called by `CBasePager::getPages()` when the pagination is not set before. Returns `CPagination` the default pagination instance.
`public integer`	# `getPageSize( )` Returns `integer` number of items in each page. See `CPagination::getPageSize()`
`public`	# `setPageSize( integer $value )` Parameters `$value` `integer` $value number of items in each page See `CPagination::setPageSize()`
`public integer`	# `getItemCount( )` Returns `integer` total number of items. See `CPagination::getItemCount()`
`public`	# `setItemCount( integer $value )` Parameters `$value` `integer` $value total number of items. See `CPagination::setItemCount()`
`public integer`	# `getPageCount( )` Returns `integer` number of pages See `CPagination::getPageCount()`
`public integer`	# `getCurrentPage( boolean $recalculate = true )` Parameters `$recalculate` `boolean` $recalculate whether to recalculate the current page based on the page size and item count. Returns `integer` the zero-based index of the current page. Defaults to 0. See `CPagination::getCurrentPage()`
`public`	# `setCurrentPage( integer $value )` Parameters `$value` `integer` $value the zero-based index of the current page. See `CPagination::setCurrentPage()`
`protected string`	# `createPageUrl( integer $page )` Creates the URL suitable for pagination. Creates the URL suitable for pagination. Parameters `$page` `integer` $page the page that the URL should point to. Returns `string` the created URL See `CPagination::createPageUrl()`

Methods inherited from CWidget
`__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), init(), render(), run(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties summary
`public CPagination`	`$pages`	# The pagination information. The pagination information.
`public integer`	`$pageSize`	# Number of items in each page. Number of items in each page.
`public integer`	`$itemCount`	# Total number of items. Total number of items.
`public integer`	`$pageCount`	# Number of pages. Number of pages.
`public integer`	`$currentPage`	# The zero-based index of the current page. Defaults to 0. The zero-based index of the current page. Defaults to 0.

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Class CBasePager

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Returns

Returns

See

Parameters

See

Returns

See

Parameters

See

Returns

See

Parameters

Returns

See

Parameters

See

Parameters

Returns

See