CJuiAccordion.php
3.07 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
<?php
/**
* CJuiAccordion class file.
*
* @author Sebastian Thierer <sebathi@gmail.com>
* @author Qiang XUe <qiang.xue@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');
/**
* CJuiAccordion displays an accordion widget.
*
* CJuiAccordion encapsulates the {@link http://jqueryui.com/demos/accordion/ JUI Accordion}
* plugin.
*
* To use this widget, you may insert the following code in a view:
* <pre>
* $this->widget('zii.widgets.jui.CJuiAccordion', array(
* 'panels'=>array(
* 'panel 1'=>'content for panel 1',
* 'panel 2'=>'content for panel 2',
* // panel 3 contains the content rendered by a partial view
* 'panel 3'=>$this->renderPartial('_partial',null,true),
* ),
* // additional javascript options for the accordion plugin
* 'options'=>array(
* 'animated'=>'bounceslide',
* ),
* ));
* </pre>
*
* By configuring the {@link options} property, you may specify the options
* that need to be passed to the JUI accordion plugin. Please refer to
* the {@link http://jqueryui.com/demos/accordion/ JUI Accordion} documentation
* for possible options (name-value pairs).
*
* @author Sebastian Thierer <sebathi@gmail.com>
* @author Qiang XUe <qiang.xue@gmail.com>
* @version $Id$
* @package zii.widgets.jui
* @since 1.1
*/
class CJuiAccordion extends CJuiWidget
{
/**
* @var array list of panels (panel title=>panel content).
* Note that neither panel title nor panel content will be HTML-encoded.
*/
public $panels=array();
/**
* @var string the name of the container element that contains all panels. Defaults to 'div'.
*/
public $tagName='div';
/**
* @var string the template that is used to generated every panel header.
* The token "{title}" in the template will be replaced with the panel title.
* Note that if you make change to this template, you may also need to adjust
* the 'header' setting in {@link options}.
*/
public $headerTemplate='<h3><a href="#">{title}</a></h3>';
/**
* @var string the template that is used to generated every panel content.
* The token "{content}" in the template will be replaced with the panel content.
*/
public $contentTemplate='<div>{content}</div>';
/**
* 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;
echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
foreach($this->panels as $title=>$content)
{
echo strtr($this->headerTemplate,array('{title}'=>$title))."\n";
echo strtr($this->contentTemplate,array('{content}'=>$content))."\n";
}
echo CHtml::closeTag($this->tagName);
$options=empty($this->options) ? '' : CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').accordion($options);");
}
}