0 follower

CBasePager

Package system.web.widgets.pagers
Inheritance abstract class CBasePager » CWidget » CBaseController » CComponent
Subclasses CLinkPager, CListPager
Since 1.0
Version $Id$
Source Code framework/web/widgets/pagers/CBasePager.php
CBasePager is the base class for all pagers.

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

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
actionPrefix string the prefix to the IDs of the actions. CWidget
controller CController the controller that this widget belongs to. CWidget
currentPage integer the zero-based index of the current page. CBasePager
id string id of the widget. CWidget
itemCount integer total number of items. CBasePager
owner CBaseController owner/creator of this widget. CWidget
pageCount integer number of pages CBasePager
pageSize integer number of items in each page. CBasePager
pages CPagination Returns the pagination information used by this pager. CBasePager
viewPath string Returns the directory containing the view files for this widget. CWidget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CWidget
__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
actions() Returns a list of actions that are used by this widget. CWidget
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
beginCache() Begins fragment caching. CBaseController
beginClip() Begins recording a clip. CBaseController
beginContent() Begins the rendering of content that is to be decorated by the specified view. CBaseController
beginWidget() Creates a widget and executes it. CBaseController
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
createWidget() Creates a widget and initializes it. CBaseController
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
endCache() Ends fragment caching. CBaseController
endClip() Ends recording a clip. CBaseController
endContent() Ends the rendering of content. CBaseController
endWidget() Ends the execution of the named widget. CBaseController
getController() Returns the controller that this widget belongs to. CWidget
getCurrentPage() Returns the zero-based index of the current page. Defaults to 0. CBasePager
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getId() Returns id of the widget. CWidget
getItemCount() Returns total number of items. CBasePager
getOwner() Returns owner/creator of this widget. It could be either a widget or a controller. CWidget
getPageCount() Returns number of pages CBasePager
getPageSize() Returns number of items in each page. CBasePager
getPages() Returns the pagination information used by this pager. CBasePager
getViewFile() Looks for the view script file according to the view name. CWidget
getViewPath() Returns the directory containing the view files for this widget. CWidget
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
init() Initializes the widget. CWidget
raiseEvent() Raises an event. CComponent
render() Renders a view. CWidget
renderFile() Renders a view file. CBaseController
renderInternal() Renders a view file. CBaseController
run() Executes the widget. CWidget
setCurrentPage() Sets the zero-based index of the current page. CBasePager
setId() Sets id of the widget. CWidget
setItemCount() Sets total number of items. CBasePager
setPageSize() Sets number of items in each page CBasePager
setPages() Sets the pagination information used by this pager. CBasePager
widget() Creates a widget and executes it. CBaseController

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createPageUrl() Creates the URL suitable for pagination. CBasePager
createPages() Creates the default pagination. CBasePager

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.

See Also

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

total number of items.

See Also

pageCount property read-only
public integer getPageCount()

number of pages

See Also

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

number of items in each page.

See Also

pages property
public CPagination getPages()
public void setPages(CPagination $pages)

Returns the pagination information used by this pager.

Method Details

createPageUrl() method
protected string createPageUrl(integer $page)
$page integer the page that the URL should point to.
{return} string the created URL
Source Code: framework/web/widgets/pagers/CBasePager.php#125 (show)
protected function createPageUrl($page)
{
    return $this->getPages()->createPageUrl($this->getController(),$page);
}

Creates the URL suitable for pagination.

See Also

createPages() method
protected CPagination createPages()
{return} CPagination the default pagination instance.
Source Code: framework/web/widgets/pagers/CBasePager.php#50 (show)
protected function createPages()
{
    return new CPagination;
}

Creates the default pagination. This is called by getPages when the pagination is not set before.

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.
Source Code: framework/web/widgets/pagers/CBasePager.php#105 (show)
public function getCurrentPage($recalculate=true)
{
    return $this->getPages()->getCurrentPage($recalculate);
}

See Also

getItemCount() method
public integer getItemCount()
{return} integer total number of items.
Source Code: framework/web/widgets/pagers/CBasePager.php#77 (show)
public function getItemCount()
{
    return $this->getPages()->getItemCount();
}

See Also

getPageCount() method
public integer getPageCount()
{return} integer number of pages
Source Code: framework/web/widgets/pagers/CBasePager.php#95 (show)
public function getPageCount()
{
    return $this->getPages()->getPageCount();
}

See Also

getPageSize() method
public integer getPageSize()
{return} integer number of items in each page.
Source Code: framework/web/widgets/pagers/CBasePager.php#59 (show)
public function getPageSize()
{
    return $this->getPages()->getPageSize();
}

See Also

getPages() method
public CPagination getPages()
{return} CPagination the pagination information
Source Code: framework/web/widgets/pagers/CBasePager.php#29 (show)
public function getPages()
{
    if($this->_pages===null)
        $this->_pages=$this->createPages();
    return $this->_pages;
}

Returns the pagination information used by this pager.

setCurrentPage() method
public void setCurrentPage(integer $value)
$value integer the zero-based index of the current page.
Source Code: framework/web/widgets/pagers/CBasePager.php#114 (show)
public function setCurrentPage($value)
{
    $this->getPages()->setCurrentPage($value);
}

See Also

setItemCount() method
public void setItemCount(integer $value)
$value integer total number of items.
Source Code: framework/web/widgets/pagers/CBasePager.php#86 (show)
public function setItemCount($value)
{
    $this->getPages()->setItemCount($value);
}

See Also

setPageSize() method
public void setPageSize(integer $value)
$value integer number of items in each page
Source Code: framework/web/widgets/pagers/CBasePager.php#68 (show)
public function setPageSize($value)
{
    $this->getPages()->setPageSize($value);
}

See Also

setPages() method
public void setPages(CPagination $pages)
$pages CPagination the pagination information
Source Code: framework/web/widgets/pagers/CBasePager.php#40 (show)
public function setPages($pages)
{
    $this->_pages=$pages;
}

Sets the pagination information used by this pager.