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

Подробности свойств

afterAjaxUpdate свойство

public string $afterAjaxUpdate;

Функция JavaScript, которая будет вызвана после успешного получения ответа AJAX. Подпись функции: function(id, data) , где «id» относится к ID списка, а «data» — к полученным данным ответа AJAX.

ajaxType свойство (доступно с v1.1.14)

public string $ajaxType;

Тип («GET» или «POST») запросов AJAX. Если не задано, используется «GET». Вы можете установить значение «POST», если фильтруете по многим полям одновременно и у вас проблемы с длиной строки запроса GET. Обратите внимание, что в режиме POST прямые ссылки и функция enableHistory могут работать некорректно!

ajaxUpdate свойство

public mixed $ajaxUpdate;

ID контейнера, содержимое которого может быть обновлено с помощью ответа AJAX. По умолчанию null, что означает контейнер для данного экземпляра списка. Если значение false, сортировка и постраничная навигация будут выполняться в обычных запросах страницы вместо запросов AJAX. Если сортировка и постраничная навигация должны вызывать обновление содержимого нескольких контейнеров по методу AJAX, эти идентификаторы контейнеров могут быть перечислены здесь (разделены запятыми).

ajaxUpdateError свойство (доступно с v1.1.13)

public string $ajaxUpdateError;

Функция JavaScript, которая будет вызвана в случае ошибки обновления AJAX.

Подпись функции: function(xhr, textStatus, errorThrown, errorMessage)

• xhr — объект XMLHttpRequest.
• textStatus — строка, описывающая тип произошедшей ошибки. Возможные значения (кроме null) — «timeout», «error», «notmodified» и «parsererror»
• errorThrown — необъект исключения, если таковое имело место.
• errorMessage — стандартное сообщение об ошибке CGridView, полученное из xhr и errorThrown. Полезно, если вы просто хотите отобразить эту ошибку по-другому. CGridView по умолчанию отображает эту ошибку с помощью javascript.alert()

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

ajaxUrl свойство (доступно с v1.1.8)

public mixed $ajaxUrl;

URL для запросов AJAX, который должен быть отправлен. На это свойство будет применено CHtml::normalizeUrl(). Если не указано, для запросов AJAX будет использоваться текущий URL страницы.

ajaxVar свойство

public string $ajaxVar;

Имя переменной GET, которая указывает, что запрос является запросом AJAX, инициированным этим виджетом. По умолчанию «ajax». Это эффективно только тогда, когда ajaxUpdate не равно false.

baseScriptUrl свойство

public string $baseScriptUrl;

Базовый URL скрипта для всех ресурсов списка (например, файлы JavaScript, CSS, изображения). По умолчанию null, что означает использование интегрированных ресурсов списка (которые публикуются как активы).

beforeAjaxUpdate свойство

public string $beforeAjaxUpdate;

Функция JavaScript, которая будет вызвана перед обновлением AJAX. Подпись функции: function(id) , где «id» относится к ID списка.

cssFile свойство

public string $cssFile;

URL файла CSS, используемого этим списком. По умолчанию null, что означает использование интегрированного файла CSS. Если это значение равно false, вы несёте ответственность за явное включение необходимого файла CSS на вашей странице.

enableHistory свойство (доступно с v1.1.11)

public boolean $enableHistory;

Нужно ли использовать объект истории DOM DOM history object. Установите это свойство в значение true, чтобы сохранить состояние списка при повторном посещении страницы. Обратите внимание на два ограничения для этой функции: — Эта функция совместима только с браузерами, поддерживающими HTML5. — Ожидайте непредсказуемого поведения (например, нескольких запросов AJAX) если на одной странице имеется более одной сетки/списка с включённой функцией enableHistory.

itemView свойство

public string $itemView;

Вид, используемый для отображения каждого элемента данных. Это значение свойства будет передано в качестве первого параметра либо CController::renderPartial, либо CWidget::render для отображения каждого элемента данных. В соответствующей шаблоне представления, помимо переменных, объявленных в viewData, можно использовать следующие переменные:

• $this: относится к владельцу этого виджета списка. Например, если виджет находится в представлении контроллера, то $this относится к контроллеру.
• $data: относится к элементу данных, который в данный момент отображается.
• $index: относится к нулевому индексу элемента данных, который в данный момент отображается.
• $widget: относится к экземпляру этого виджета списка.

itemsTagName свойство (доступно с v1.1.4)

public string $itemsTagName;

Имя HTML-тега для контейнера отображения всех элементов данных. По умолчанию «div».

loadingCssClass свойство (доступно с v1.1.1)

public string $loadingCssClass;

Имя класса CSS, которое будет назначено элементу контейнера виджета при обновлении виджетом своего содержимого с помощью AJAX. По умолчанию «list-view-loading».

separator свойство (доступно с v1.1.7)

public string $separator;

HTML-код, который будет отображаться между любыми двумя последовательными элементами.

sortableAttributes свойство

public array $sortableAttributes;

Список имён сортируемых атрибутов. Для того, чтобы атрибут был сортируемым, он также должен быть сортируемым атрибутом в свойстве IDataProvider::sort объекта dataProvider.

sorterCssClass свойство

public string $sorterCssClass;

Имя класса CSS для контейнера сортировки. По умолчанию «sorter».

sorterFooter свойство

public string $sorterFooter;

Текст, отображаемый после ссылок сортировки. По умолчанию пусто.

sorterHeader свойство

public string $sorterHeader;

Текст, отображаемый перед ссылками сортировки. По умолчанию «Сортировать по: ».

template свойство

public string $template;

Шаблон, используемый для управления макетом различных компонентов в списке. Различаются следующие токены: {summary}, {sorter}, {items} и {pager}. Они будут заменены на текст резюме, ссылки сортировки, список элементов данных и постраничную навигацию.

updateSelector свойство (доступно с v1.1.7)

public string $updateSelector;

jQuery-селектор HTML-элементов, которые могут инициировать обновления AJAX при нажатии на них. Если не задано, ссылки постраничной навигации и ссылки сортировки будут инициировать обновления AJAX.

viewData свойство

public array $viewData;

Дополнительные данные, передаваемые в itemView при отображении каждого элемента данных. Этот массив будет преобразован в локальные PHP-переменные, доступные в itemView.

Подробности методов

init() метод

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

Инициализирует список. Этот метод инициализирует необходимые значения свойств и создаёт объекты столбцов.

registerClientScript() метод

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

Регистрирует необходимые скрипты клиента.

renderItems() метод

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

Отображает список элементов данных.

renderSorter() метод

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

Отображает сортировку.