Package | system.web.widgets.pagers |
---|---|
Inheritance | abstract class CBasePager » CWidget » CBaseController » CComponent |
Subclasses | CLinkPager, CListPager |
Since | 1.0 |
Source Code | framework/web/widgets/pagers/CBasePager.php |
Property | Type | Description | Defined By |
---|---|---|---|
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 |
Method | Description | Defined 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 |
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 |
Method | Description | Defined By |
---|---|---|
createPageUrl() | Creates the URL suitable for pagination. | CBasePager |
createPages() | Creates the default pagination. | CBasePager |
public integer getCurrentPage(boolean $recalculate=true)
public void setCurrentPage(integer $value)
the zero-based index of the current page. Defaults to 0.
public integer getItemCount()
public void setItemCount(integer $value)
total number of items.
public integer getPageCount()
number of pages
public integer getPageSize()
public void setPageSize(integer $value)
number of items in each page.
public CPagination getPages()
public void setPages(CPagination $pages)
Returns the pagination information used by this pager.
protected string createPageUrl(integer $page) | ||
$page | integer | the page that the URL should point to. |
{return} | string | the created URL |
protected function createPageUrl($page)
{
return $this->getPages()->createPageUrl($this->getController(),$page);
}
Creates the URL suitable for pagination.
protected CPagination createPages() | ||
{return} | CPagination | the default pagination instance. |
protected function createPages()
{
return new CPagination;
}
Creates the default pagination. This is called by getPages when the pagination is not set before.
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. |
public function getCurrentPage($recalculate=true)
{
return $this->getPages()->getCurrentPage($recalculate);
}
public integer getItemCount() | ||
{return} | integer | total number of items. |
public function getItemCount()
{
return $this->getPages()->getItemCount();
}
public integer getPageCount() | ||
{return} | integer | number of pages |
public function getPageCount()
{
return $this->getPages()->getPageCount();
}
public integer getPageSize() | ||
{return} | integer | number of items in each page. |
public function getPageSize()
{
return $this->getPages()->getPageSize();
}
public CPagination getPages() | ||
{return} | CPagination | the pagination information |
public function getPages()
{
if($this->_pages===null)
$this->_pages=$this->createPages();
return $this->_pages;
}
Returns the pagination information used by this pager.
public void setCurrentPage(integer $value) | ||
$value | integer | the zero-based index of the current page. |
public function setCurrentPage($value)
{
$this->getPages()->setCurrentPage($value);
}
public void setItemCount(integer $value) | ||
$value | integer | total number of items. |
public function setItemCount($value)
{
$this->getPages()->setItemCount($value);
}
public void setPageSize(integer $value) | ||
$value | integer | number of items in each page |
public function setPageSize($value)
{
$this->getPages()->setPageSize($value);
}
public void setPages(CPagination $pages) | ||
$pages | CPagination | the pagination information |
public function setPages($pages)
{
$this->_pages=$pages;
}
Sets the pagination information used by this pager.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBasePager