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',
    ),
));

属性详细

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.

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).

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.

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.

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).

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.

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.

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.

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

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'.

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

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.

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

the text shown after sort links. Defaults to empty.

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

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.

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.

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.

方法详细

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);
    }
}

初始化list view。 这个方法会初始化请求值并实例化列columns对象。

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,
    );
    if($this->ajaxUrl!==null)
        $options['url']=CHtml::normalizeUrl($this->ajaxUrl);
    if($this->updateSelector!==null)
        $options['updateSelector']=$this->updateSelector;
    if($this->beforeAjaxUpdate!==null)
        $options['beforeAjaxUpdate']=(strpos($this->beforeAjaxUpdate,'js:')!==0 ? 'js:' : '').$this->beforeAjaxUpdate;
    if($this->afterAjaxUpdate!==null)
        $options['afterAjaxUpdate']=(strpos($this->afterAjaxUpdate,'js:')!==0 ? 'js:' : '').$this->afterAjaxUpdate;

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

注册必要的客户端脚本。

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();
        $render=$owner instanceof CController ? 'renderPartial' : 'render';
        $j=0;
        foreach($data as $i=>$item)
        {
            $data=$this->viewData;
            $data['index']=$i;
            $data['data']=$item;
            $data['widget']=$this;
            $owner->$render($this->itemView,$data);
            if($j++ < $n-1)
                echo $this->separator;
        }
    }
    else
        $this->renderEmptyText();
    echo CHtml::closeTag($this->itemsTagName);
}

显示每一个数据项。

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');
}

显示排序了的数据。