CListView

$dataProvider=new CActiveDataProvider('Post');

$this->widget('zii.widgets.CListView', array(
    'dataProvider'=>$dataProvider,
    'itemView'=>'_post',   // refers to the partial view named '_post'
    'sortableAttributes'=>array(
        'title',
        'create_time'=>'Post Time',
    ),
));

Property Details

afterAjaxUpdate property

public string $afterAjaxUpdate;

a javascript function that will be invoked after a successful AJAX response is received. The function signature is function(id, data) where 'id' refers to the ID of the list view 'data' the received ajax response data.

ajaxType property (available since v1.1.14)

public string $ajaxType;

the type ('GET' or 'POST') of the AJAX requests. If not set, 'GET' will be used. You can set this to 'POST' if you are filtering by many fields at once and have a problem with GET query string length. Note that in POST mode direct links and enableHistory feature may not work correctly!

ajaxUpdate property

public mixed $ajaxUpdate;

the ID of the container whose content may be updated with an AJAX response. Defaults to null, meaning the container for this list view instance. If it is set false, it means sorting and pagination will be performed in normal page requests instead of AJAX requests. If the sorting and pagination should trigger the update of multiple containers' content in AJAX fashion, these container IDs may be listed here (separated with comma).

ajaxUpdateError property (available since v1.1.13)

public string $ajaxUpdateError;

a javascript function that will be invoked if an AJAX update error occurs.

The function signature is function(xhr, textStatus, errorThrown, errorMessage)

• xhr is the XMLHttpRequest object.
• textStatus is a string describing the type of error that occurred. Possible values (besides null) are "timeout", "error", "notmodified" and "parsererror"
• errorThrown is an optional exception object, if one occurred.
• errorMessage is the CGridView default error message derived from xhr and errorThrown. Usefull if you just want to display this error differently. CGridView by default displays this error with an javascript.alert()

 ...
 'ajaxUpdateError'=>'function(xhr,ts,et,err,id){ $("#"+id).text(err); }',
 ...

ajaxUrl property (available since v1.1.8)

public mixed $ajaxUrl;

the URL for the AJAX requests should be sent to. CHtml::normalizeUrl() will be called on this property. If not set, the current page URL will be used for AJAX requests.

ajaxVar property

public string $ajaxVar;

the name of the GET variable that indicates the request is an AJAX request triggered by this widget. Defaults to 'ajax'. This is effective only when ajaxUpdate is not false.

baseScriptUrl property

public string $baseScriptUrl;

the base script URL for all list view resources (e.g. javascript, CSS file, images). Defaults to null, meaning using the integrated list view resources (which are published as assets).

beforeAjaxUpdate property

public string $beforeAjaxUpdate;

a javascript function that will be invoked before an AJAX update occurs. The function signature is function(id) where 'id' refers to the ID of the list view.

cssFile property

public string $cssFile;

the URL of the CSS file used by this list view. Defaults to null, meaning using the integrated CSS file. If this is set false, you are responsible to explicitly include the necessary CSS file in your page.

enableHistory property (available since v1.1.11)

public boolean $enableHistory;

whether to leverage the DOM history object. Set this property to true to persist state of list across page revisits. Note, there are two limitations for this feature: - this feature is only compatible with browsers that support HTML5. - expect unexpected functionality (e.g. multiple ajax calls) if there is more than one grid/list on a single page with enableHistory turned on.

itemView property

public string $itemView;

the view used for rendering each data item. This property value will be passed as the first parameter to either CController::renderPartial or CWidget::render to render each data item. In the corresponding view template, the following variables can be used in addition to those declared in viewData:

• $this: refers to the owner of this list view widget. For example, if the widget is in the view of a controller, then $this refers to the controller.
• $data: refers to the data item currently being rendered.
• $index: refers to the zero-based index of the data item currently being rendered.
• $widget: refers to this list view widget instance.

itemsTagName property (available since v1.1.4)

public string $itemsTagName;

the HTML tag name for the container of all data item display. Defaults to 'div'.

loadingCssClass property (available since v1.1.1)

public string $loadingCssClass;

the CSS class name that will be assigned to the widget container element when the widget is updating its content via AJAX. Defaults to 'list-view-loading'.

separator property (available since v1.1.7)

public string $separator;

the HTML code to be displayed between any two consecutive items.

sortableAttributes property

public array $sortableAttributes;

list of sortable attribute names. In order for an attribute to be sortable, it must also appear as a sortable attribute in the IDataProvider::sort property of dataProvider.

sorterCssClass property

public string $sorterCssClass;

the CSS class name for the sorter container. Defaults to 'sorter'.

sorterFooter property

public string $sorterFooter;

the text shown after sort links. Defaults to empty.

sorterHeader property

public string $sorterHeader;

the text shown before sort links. Defaults to 'Sort by: '.

template property

public string $template;

the template to be used to control the layout of various components in the list view. These tokens are recognized: {summary}, {sorter}, {items} and {pager}. They will be replaced with the summary text, the sort links, the data item list, and the pager.

updateSelector property (available since v1.1.7)

public string $updateSelector;

the jQuery selector of the HTML elements that may trigger AJAX updates when they are clicked. If not set, the pagination links and the sorting links will trigger AJAX updates.

viewData property

public array $viewData;

additional data to be passed to itemView when rendering each data item. This array will be extracted into local PHP variables that can be accessed in the itemView.

Method Details

init() method

public void init()

public function init()
{
    if($this->itemView===null)
        throw new CException(Yii::t('zii','The property "itemView" cannot be empty.'));
    parent::init();

    if(!isset($this->htmlOptions['class']))
        $this->htmlOptions['class']='list-view';

    if($this->baseScriptUrl===null)
        $this->baseScriptUrl=Yii::app()->getAssetManager()->publish(Yii::getPathOfAlias('zii.widgets.assets')).'/listview';

    if($this->cssFile!==false)
    {
        if($this->cssFile===null)
            $this->cssFile=$this->baseScriptUrl.'/styles.css';
        Yii::app()->getClientScript()->registerCssFile($this->cssFile);
    }
}

Initializes the list view. This method will initialize required property values and instantiate columns objects.

registerClientScript() method

public void registerClientScript()

public function registerClientScript()
{
    $id=$this->getId();

    if($this->ajaxUpdate===false)
        $ajaxUpdate=array();
    else
        $ajaxUpdate=array_unique(preg_split('/\s*,\s*/',$this->ajaxUpdate.','.$id,-1,PREG_SPLIT_NO_EMPTY));
    $options=array(
        'ajaxUpdate'=>$ajaxUpdate,
        'ajaxVar'=>$this->ajaxVar,
        'pagerClass'=>$this->pagerCssClass,
        'loadingClass'=>$this->loadingCssClass,
        'sorterClass'=>$this->sorterCssClass,
        'enableHistory'=>$this->enableHistory
    );
    if($this->ajaxUrl!==null)
        $options['url']=CHtml::normalizeUrl($this->ajaxUrl);
    if($this->ajaxType!==null)
        $options['ajaxType']=strtoupper($this->ajaxType);
    if($this->updateSelector!==null)
        $options['updateSelector']=$this->updateSelector;
    foreach(array('beforeAjaxUpdate', 'afterAjaxUpdate', 'ajaxUpdateError') as $event)
    {
        if($this->$event!==null)
        {
            if($this->$event instanceof CJavaScriptExpression)
                $options[$event]=$this->$event;
            else
                $options[$event]=new CJavaScriptExpression($this->$event);
        }
    }

    $options=CJavaScript::encode($options);
    $cs=Yii::app()->getClientScript();
    $cs->registerCoreScript('jquery');
    $cs->registerCoreScript('bbq');
    if($this->enableHistory)
        $cs->registerCoreScript('history');
    $cs->registerScriptFile($this->baseScriptUrl.'/jquery.yiilistview.js',CClientScript::POS_END);
    $cs->registerScript(__CLASS__.'#'.$id,"jQuery('#$id').yiiListView($options);");
}

Registers necessary client scripts.

renderItems() method

public void renderItems()

public function renderItems()
{
    echo CHtml::openTag($this->itemsTagName,array('class'=>$this->itemsCssClass))."\n";
    $data=$this->dataProvider->getData();
    if(($n=count($data))>0)
    {
        $owner=$this->getOwner();
        $viewFile=$owner->getViewFile($this->itemView);
        $j=0;
        foreach($data as $i=>$item)
        {
            $data=$this->viewData;
            $data['index']=$i;
            $data['data']=$item;
            $data['widget']=$this;
            $owner->renderFile($viewFile,$data);
            if($j++ < $n-1)
                echo $this->separator;
        }
    }
    else
        $this->renderEmptyText();
    echo CHtml::closeTag($this->itemsTagName);
}

Renders the data item list.

renderSorter() method

public void renderSorter()

public function renderSorter()
{
    if($this->dataProvider->getItemCount()<=0 || !$this->enableSorting || empty($this->sortableAttributes))
        return;
    echo CHtml::openTag('div',array('class'=>$this->sorterCssClass))."\n";
    echo $this->sorterHeader===null ? Yii::t('zii','Sort by: ') : $this->sorterHeader;
    echo "<ul>\n";
    $sort=$this->dataProvider->getSort();
    foreach($this->sortableAttributes as $name=>$label)
    {
        echo "<li>";
        if(is_integer($name))
            echo $sort->link($label);
        else
            echo $sort->link($name,$label);
        echo "</li>\n";
    }
    echo "</ul>";
    echo $this->sorterFooter;
    echo CHtml::closeTag('div');
}

Renders the sorter.