CBasePager

所有包 | 属性 | 方法

包	system.web.widgets.pagers
继承	abstract class CBasePager » CWidget » CBaseController » CComponent
子类	CLinkPager, CListPager
可用自	1.0
源码	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.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
actionPrefix	string	the prefix to the IDs of the actions.	CWidget
controller	CController	Returns the controller that this widget belongs to.	CWidget
currentPage	integer	the zero-based index of the current page.	CBasePager
id	string	Returns the ID of the widget or generates a new one if requested.	CWidget
itemCount	integer	total number of items.	CBasePager
owner	CBaseController	Returns the 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
skin	mixed	the name of the skin to be used by this widget.	CWidget
viewPath	string	Returns the directory containing the view files for this widget.	CWidget

公共方法

隐藏继承的方法

方法	描述	被定义在
__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
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
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 the ID of the widget or generates a new one if requested.	CWidget
getItemCount()	Returns total number of items.	CBasePager
getOwner()	Returns the owner/creator of this widget.	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 the 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

受保护的方法

隐藏继承的方法

方法	描述	被定义在
createPageUrl()	Creates the URL suitable for pagination.	CBasePager
createPages()	Creates the default pagination.	CBasePager

属性详情

currentPage 属性

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

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

参见

CPagination::getCurrentPage

itemCount 属性

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

total number of items.

参见

CPagination::getItemCount

pageCount 属性只读

public integer getPageCount()

number of pages

参见

CPagination::getPageCount

pageSize 属性

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

number of items in each page.

参见

CPagination::getPageSize

pages 属性

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

Returns the pagination information used by this pager.

方法详情

createPageUrl() 方法

protected string createPageUrl(integer $page)
$page	integer	the page that the URL should point to.
{return}	string	the created URL

源码： framework/web/widgets/pagers/CBasePager.php#130 (显示)


protected function createPageUrl($page)
{
    return $this->getPages()->createPageUrl($this->getController(),$page);
}

Creates the URL suitable for pagination.

参见

CPagination::createPageUrl

createPages() 方法

protected CPagination createPages()
{return}	CPagination	the default pagination instance.

源码： framework/web/widgets/pagers/CBasePager.php#55 (显示)


protected function createPages()
{
    return new CPagination;
}

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

getCurrentPage() 方法

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.

源码： framework/web/widgets/pagers/CBasePager.php#110 (显示)


public function getCurrentPage($recalculate=true)
{
    return $this->getPages()->getCurrentPage($recalculate);
}

参见

CPagination::getCurrentPage

getItemCount() 方法

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

源码： framework/web/widgets/pagers/CBasePager.php#82 (显示)


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

参见

CPagination::getItemCount

getPageCount() 方法

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

源码： framework/web/widgets/pagers/CBasePager.php#100 (显示)


public function getPageCount()
{
    return $this->getPages()->getPageCount();
}

参见

CPagination::getPageCount

getPageSize() 方法

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

源码： framework/web/widgets/pagers/CBasePager.php#64 (显示)


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

参见

CPagination::getPageSize

getPages() 方法

public CPagination getPages()
{return}	CPagination	the pagination information

源码： framework/web/widgets/pagers/CBasePager.php#34 (显示)


public function getPages()
{
    if($this->_pages===null)
        $this->_pages=$this->createPages();
    return $this->_pages;
}

Returns the pagination information used by this pager.

setCurrentPage() 方法

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

源码： framework/web/widgets/pagers/CBasePager.php#119 (显示)


public function setCurrentPage($value)
{
    $this->getPages()->setCurrentPage($value);
}

参见

CPagination::setCurrentPage

setItemCount() 方法

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

源码： framework/web/widgets/pagers/CBasePager.php#91 (显示)


public function setItemCount($value)
{
    $this->getPages()->setItemCount($value);
}

参见

CPagination::setItemCount

setPageSize() 方法

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

源码： framework/web/widgets/pagers/CBasePager.php#73 (显示)


public function setPageSize($value)
{
    $this->getPages()->setPageSize($value);
}

参见

CPagination::setPageSize

setPages() 方法

public void setPages(CPagination $pages)
$pages	CPagination	the pagination information

源码： framework/web/widgets/pagers/CBasePager.php#45 (显示)


public function setPages($pages)
{
    $this->_pages=$pages;
}

Sets the pagination information used by this pager.