Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 276 lines (265 sloc) 10.383 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
<?php
/**
* CListView class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008-2011 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/

Yii::import('zii.widgets.CBaseListView');

/**
* CListView displays a list of data items in terms of a list.
*
* Unlike {@link CGridView} which displays the data items in a table, CListView allows one to use
* a view template to render each data item. As a result, CListView could generate more flexible
* rendering result.
*
* CListView supports both sorting and pagination of the data items. The sorting
* and pagination can be done in AJAX mode or normal page request. A benefit of using CListView is that
* when the user browser disables JavaScript, the sorting and pagination automatically degenerate
* to normal page requests and are still functioning as expected.
*
* CListView should be used together with a {@link IDataProvider data provider}, preferrably a
* {@link CActiveDataProvider}.
*
* The minimal code needed to use CListView is as follows:
*
* <pre>
* $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',
* ),
* ));
* </pre>
*
* The above code first creates a data provider for the <code>Post</code> ActiveRecord class.
* It then uses CListView to display every data item as returned by the data provider.
* The display is done via the partial view named '_post'. This partial view will be rendered
* once for every data item. In the view, one can access the current data item via variable <code>$data</code>.
* For more details, see {@link itemView}.
*
* In order to support sorting, one has to specify the {@link sortableAttributes} property.
* By doing so, a list of hyperlinks that can sort the data will be displayed.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
* @package zii.widgets
* @since 1.1
*/
class CListView extends CBaseListView
{
/**
* @var string the view used for rendering each data item.
* This property value will be passed as the first parameter to either {@link CController::renderPartial}
* or {@link CWidget::render} to render each data item.
* In the corresponding view template, the following variables can be used in addition to those declared in {@link viewData}:
* <ul>
* <li><code>$this</code>: refers to the owner of this list view widget. For example, if the widget is in the view of a controller,
* then <code>$this</code> refers to the controller.</li>
* <li><code>$data</code>: refers to the data item currently being rendered.</li>
* <li><code>$index</code>: refers to the zero-based index of the data item currently being rendered.</li>
* <li><code>$widget</code>: refers to this list view widget instance.</li>
* </ul>
*/
public $itemView;
/**
* @var string the HTML code to be displayed between any two consecutive items.
* @since 1.1.7
*/
public $separator;
/**
* @var array additional data to be passed to {@link itemView} when rendering each data item.
* This array will be extracted into local PHP variables that can be accessed in the {@link itemView}.
*/
public $viewData=array();
/**
* @var array list of sortable attribute names. In order for an attribute to be sortable, it must also
* appear as a sortable attribute in the {@link IDataProvider::sort} property of {@link dataProvider}.
* @see enableSorting
*/
public $sortableAttributes;
/**
* @var string 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.
*/
public $template="{summary}\n{sorter}\n{items}\n{pager}";
/**
* @var string 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'.
* @since 1.1.1
*/
public $loadingCssClass='list-view-loading';
/**
* @var string the CSS class name for the sorter container. Defaults to 'sorter'.
*/
public $sorterCssClass='sorter';
/**
* @var string the text shown before sort links. Defaults to 'Sort by: '.
*/
public $sorterHeader;
/**
* @var string the text shown after sort links. Defaults to empty.
*/
public $sorterFooter='';
/**
* @var mixed 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).
*/
public $ajaxUpdate;
/**
* @var string 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.
* @since 1.1.7
*/
public $updateSelector;
/**
* @var string 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 {@link ajaxUpdate} is not false.
*/
public $ajaxVar='ajax';
/**
* @var mixed the URL for the AJAX requests should be sent to. {@link CHtml::normalizeUrl()} will be
* called on this property. If not set, the current page URL will be used for AJAX requests.
* @since 1.1.8
*/
public $ajaxUrl;
/**
* @var string a javascript function that will be invoked before an AJAX update occurs.
* The function signature is <code>function(id)</code> where 'id' refers to the ID of the list view.
*/
public $beforeAjaxUpdate;
/**
* @var string a javascript function that will be invoked after a successful AJAX response is received.
* The function signature is <code>function(id, data)</code> where 'id' refers to the ID of the list view
* 'data' the received ajax response data.
*/
public $afterAjaxUpdate;
/**
* @var string 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).
*/
public $baseScriptUrl;
/**
* @var string 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.
*/
public $cssFile;
/**
* @var string the HTML tag name for the container of all data item display. Defaults to 'div'.
* @since 1.1.4
*/
public $itemsTagName='div';

/**
* Initializes the list view.
* This method will initialize required property values and instantiate {@link columns} objects.
*/
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);
}
}

/**
* Registers necessary client scripts.
*/
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);");
}

/**
* Renders the data item list.
*/
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);
}

/**
* Renders the sorter.
*/
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');
}
}
Something went wrong with that request. Please try again.