CBasePager - YII 类库手册

所有包 | 属性 | 方法

包	system.web.widgets.pagers
继承	abstract class CBasePager » CWidget » CBaseController » CComponent
子类	CLinkPager, CListPager
源自	1.0
版本	$Id: CBasePager.PHP 3426 2011-10-25 00:01:09Z alexander.makarow $
源码

CBasePager是所有pager类的基类。

它提供页面计数的计算功能，并维护当前页面。

公共属性

属性	类型	描述	定义在
actionPrefix	string	actions的ID的前缀。当微件在CController::actions中声明了动作提供者，可以为其动作的ID指定前缀以区别于别的微件或控制器。当微件用于控制器的视图中时，必须配置同样的前缀。	CWidget
controller	CController	返回此微件所属的控制器。	CWidget
currentPage	integer	当前页的索引（从0开始）。缺省为0。	CBasePager
id	string	返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。	CWidget
itemCount	integer	项目的总量。	CBasePager
owner	CBaseController	返回此微件的所有者或创建者。	CWidget
pageCount	integer	页数	CBasePager
pageSize	integer	每页包含项目的数量。	CBasePager
pages	CPagination	返回此pager所用的分页信息。	CBasePager
skin	mixed	微件使用的皮肤的名称。默认为“default”。如果此属性设置为false，微件将不会有皮肤被使用。	CWidget
viewPath	string	返回包含此微件所需的视图文件的路径。	CWidget

公共方法

方法	描述	定义在
__call()	如果类中没有调的方法名，则调用这个方法。	CComponent
__construct()	构造器。	CWidget
__get()	返回一个属性值、一个事件处理程序列表或一个行为名称。	CComponent
__isset()	检查一个属性是否为null。	CComponent
__set()	设置一个组件的属性值。	CComponent
__unset()	设置一个组件的属性为null。	CComponent
actions()	返回此widget使用的动作的列表。	CWidget
asa()	返回这个名字的行为对象。	CComponent
attachBehavior()	附加一个行为到组件。	CComponent
attachBehaviors()	附加一个行为列表到组件。	CComponent
attachEventHandler()	为事件附加一个事件处理程序。	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()	确定属性是否可读。	CComponent
canSetProperty()	确定属性是否可写。	CComponent
createWidget()	Creates a widget and initializes it.	CBaseController
detachBehavior()	从组件中分离一个行为。	CComponent
detachBehaviors()	从组件中分离所有行为。	CComponent
detachEventHandler()	分离一个存在的事件处理程序。	CComponent
disableBehavior()	禁用一个附加行为。	CComponent
disableBehaviors()	禁用组件附加的所有行为。	CComponent
enableBehavior()	启用一个附加行为。	CComponent
enableBehaviors()	启用组件附加的所有行为。	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()	计算一个PHP表达式，或根据组件上下文执行回调。	CComponent
getController()	返回此微件所属的控制器。	CWidget
getCurrentPage()	返回当前页的索引（从0开始）。缺省为0。	CBasePager
getEventHandlers()	返回一个事件的附加处理程序列表。	CComponent
getId()	返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。	CWidget
getItemCount()	返回项目的总量。	CBasePager
getOwner()	返回此微件的所有者或创建者。	CWidget
getPageCount()	返回页数	CBasePager
getPageSize()	返回每页包含项目的数量。	CBasePager
getPages()	返回此pager所用的分页信息。	CBasePager
getViewFile()	根据视图名查找视图文件。	CWidget
getViewPath()	返回包含此微件所需的视图文件的路径。	CWidget
hasEvent()	确定一个事件是否定义。	CComponent
hasEventHandler()	检查事件是否有附加的处理程序。	CComponent
hasProperty()	确定属性是否被定义。	CComponent
init()	初始化此微件。	CWidget
raiseEvent()	发起一个事件。	CComponent
render()	渲染一个视图。	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	运行此微件。	CWidget
setCurrentPage()	设置当前页的索引（从0开始）。	CBasePager
setId()	设置此微件的ID。	CWidget
setItemCount()	设置项目的总量。	CBasePager
setPageSize()	设置每页包含的项目的数量	CBasePager
setPages()	设置此pager所用的分页信息。	CBasePager
widget()	Creates a widget and executes it.	CBaseController

受保护方法

方法	描述	定义在
createPageUrl()	创建分页适用的URL。	CBasePager
createPages()	创建缺省分页。	CBasePager

属性详细

currentPage 属性

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

当前页的索引（从0开始）。缺省为0。

参见

CPagination::getCurrentPage

itemCount 属性

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

项目的总量。

参见

CPagination::getItemCount

pageCount 属性只读

public integer getPageCount()

页数

参见

CPagination::getPageCount

pageSize 属性

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

每页包含项目的数量。

参见

CPagination::getPageSize

pages 属性

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

返回此pager所用的分页信息。

方法详细

createPageUrl() 方法

protected string createPageUrl(integer $page)
$page	integer	URL所指向的页面。
{return}	string	创建的URL


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

创建分页适用的URL。

参见

CPagination::createPageUrl

createPages() 方法

protected CPagination createPages()
{return}	CPagination	缺省的分页实例。


protected function createPages()
{
    return new CPagination;
}

创建缺省分页。如果之前分页没有被指定，此方法会被getPages调用。

getCurrentPage() 方法

public integer getCurrentPage(boolean $recalculate=true)
$recalculate	boolean	是否根据每页项目数以及项目总量重新计算当前页。
{return}	integer	当前页的索引（从0开始）。缺省为0。


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

参见

CPagination::getCurrentPage

getItemCount() 方法

public integer getItemCount()
{return}	integer	项目的总量。


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

参见

CPagination::getItemCount

getPageCount() 方法

public integer getPageCount()
{return}	integer	页数


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

参见

CPagination::getPageCount

getPageSize() 方法

public integer getPageSize()
{return}	integer	每页包含项目的数量。


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

参见

CPagination::getPageSize

getPages() 方法

public CPagination getPages()
{return}	CPagination	分页信息


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

返回此pager所用的分页信息。

setCurrentPage() 方法

public void setCurrentPage(integer $value)
$value	integer	当前页的索引（从0开始）。


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

参见

CPagination::setCurrentPage

setItemCount() 方法

public void setItemCount(integer $value)
$value	integer	项目的总量。


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

参见

CPagination::setItemCount

setPageSize() 方法

public void setPageSize(integer $value)
$value	integer	每页包含的项目的数量


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

参见

CPagination::setPageSize

setPages() 方法

public void setPages(CPagination $pages)
$pages	CPagination	分页信息


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

设置此pager所用的分页信息。