Docs4dev
Docs
yii / 1.1 / clistpager.html

CListPager

Package system.web.widgets.pagers
Inheritance class CListPager » CBasePager » CWidget » CBaseController » CComponent
Since 1.0
Source Code framework/web/widgets/pagers/CListPager.php
CListPager displays a dropdown list that contains options leading to different pages of target.

Public Properties

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
htmlOptions array HTML attributes for the enclosing 'div' tag. CListPager
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
pageTextFormat string the format string used to generate page selection text. CListPager
pages CPagination Returns the pagination information used by this pager. CBasePager
promptText string the text displayed as a prompt option in the dropdown list. CListPager
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

Public Methods

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 pager by setting some default property values. CListPager
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. CListPager
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

Protected Methods

Method Description Defined By
createPageUrl() Creates the URL suitable for pagination. CBasePager
createPages() Creates the default pagination. CBasePager
generatePageText() Generates the list option for the specified page number. CListPager

Property Details

public string $footer;

the text shown after page buttons.

header property 

public string $header;

the text shown before page buttons. Defaults to 'Go to page: '.

htmlOptions property 

public array $htmlOptions;

HTML attributes for the enclosing 'div' tag.

pageTextFormat property 

public string $pageTextFormat;

the format string used to generate page selection text. The sprintf function will be used to perform the formatting.

promptText property 

public string $promptText;

the text displayed as a prompt option in the dropdown list. Defaults to null, meaning no prompt.

Method Details

generatePageText() method 

protected string generatePageText(integer $page)
$page integer zero-based page number
{return} string the list option for the page number
Source Code: framework/web/widgets/pagers/CListPager.php#81 (show) 
protected function generatePageText($page)
{
    if($this->pageTextFormat!==null)
        return sprintf($this->pageTextFormat,$page+1);
    else
        return $page+1;
}

Generates the list option for the specified page number. You may override this method to customize the option display.

init() method 

public void init()
Source Code: framework/web/widgets/pagers/CListPager.php#46 (show) 
public function init()
{
    if($this->header===null)
        $this->header=Yii::t('yii','Go to page: ');
    if(!isset($this->htmlOptions['id']))
        $this->htmlOptions['id']=$this->getId();
    if($this->promptText!==null)
        $this->htmlOptions['prompt']=$this->promptText;
    if(!isset($this->htmlOptions['onchange']))
        $this->htmlOptions['onchange']="if(this.value!='') {window.location=this.value;};";
}

Initializes the pager by setting some default property values.

run() method 

public void run()
Source Code: framework/web/widgets/pagers/CListPager.php#62 (show) 
public function run()
{
    if(($pageCount=$this->getPageCount())<=1)
        return;
    $pages=array();
    for($i=0;$i<$pageCount;++$i)
        $pages[$this->createPageUrl($i)]=$this->generatePageText($i);
    $selection=$this->createPageUrl($this->getCurrentPage());
    echo $this->header;
    echo CHtml::dropDownList($this->getId(),$selection,$pages,$this->htmlOptions);
    echo $this->footer;
}

Executes the widget. This overrides the parent implementation by displaying the generated page buttons.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CListPager