CJuiSelectable.php
2.48 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
<?php
/**
* CJuiSelectable class file.
*
* @author Sebastian Thierer <sebathi@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright © 2008-2011 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
Yii::import('zii.widgets.jui.CJuiWidget');
/**
* CJuiSelectable displays an accordion widget.
*
* CJuiSelectable encapsulates the {@link http://jqueryui.com/demos/selectable/ JUI Selectable}
* plugin.
*
* To use this widget, you may insert the following code in a view:
* <pre>
* $this->widget('zii.widgets.jui.CJuiSelectable', array(
* 'items'=>array(
* 'id1'=>'Item 1',
* 'id2'=>'Item 2',
* 'id3'=>'Item 3',
* ),
* // additional javascript options for the selectable plugin
* 'options'=>array(
* 'delay'=>'300',
* ),
* ));
* </pre>
*
* By configuring the {@link options} property, you may specify the options
* that need to be passed to the JUI Selectable plugin. Please refer to
* the {@link http://jqueryui.com/demos/selectable/ JUI Selectable} documentation
* for possible options (name-value pairs).
*
* @author Sebastian Thierer <sebathi@gmail.com>
* @version $Id$
* @package zii.widgets.jui
* @since 1.1
*/
class CJuiSelectable extends CJuiWidget {
/**
* @var array list of selectable items (id=>item content).
* Note that the item contents will not be HTML-encoded.
*/
public $items=array();
/**
* @var string the name of the container element that contains all items. Defaults to 'ol'.
*/
public $tagName='ol';
/**
* @var string the template that is used to generated every selectable item.
* The token "{content}" in the template will be replaced with the item content,
* while "{id}" will be replaced with the item ID.
*/
public $itemTemplate='<li id="{id}">{content}</li>';
/**
* Run this widget.
* This method registers necessary javascript and renders the needed HTML code.
*/
public function run(){
$id=$this->getId();
if (isset($this->htmlOptions['id']))
$id = $this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
$options=empty($this->options) ? '' : CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').selectable({$options});");
echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
foreach($this->items as $id=>$content)
{
echo strtr($this->itemTemplate,array('{id}'=>$id,'{content}'=>$content))."\n";
}
echo CHtml::closeTag($this->tagName);
}
}