Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

86 lines (81 sloc) 2.711 kB
<?php
/**
* CJuiSortable class file.
*
* @author Sebastian Thierer <sebathi@gmail.com>
* @link http://www.yiiframework.com/
* @copyright 2008-2013 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
Yii::import('zii.widgets.jui.CJuiWidget');
/**
* CJuiSortable makes selected elements sortable by dragging with the mouse.
*
* CJuiSortable encapsulates the {@link http://jqueryui.com/sortable/ JUI Sortable}
* plugin.
*
* To use this widget, you may insert the following code in a view:
* <pre>
* $this->widget('zii.widgets.jui.CJuiSortable',array(
* 'items'=>array(
* 'id1'=>'Item 1',
* 'id2'=>'Item 2',
* 'id3'=>'Item 3',
* ),
* // additional javascript options for the JUI Sortable 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 Sortable plugin. Please refer to
* the {@link http://api.jqueryui.com/sortable/ JUI Sortable API} documentation
* for possible options (name-value pairs) and
* {@link http://jqueryui.com/sortable/ JUI Sortable page} for general
* description and demo.
*
* If you are using JavaScript expressions anywhere in the code, please wrap it
* with {@link CJavaScriptExpression} and Yii will use it as code.
*
* @author Sebastian Thierer <sebathi@gmail.com>
* @package zii.widgets.jui
* @since 1.1
*/
class CJuiSortable extends CJuiWidget
{
/**
* @var array list of sortable 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 'ul'.
*/
public $tagName='ul';
/**
* @var string the template that is used to generated every sortable item.
* The token "{content}" in the template will be replaced with the item content,
* while "{id}" 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=CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').sortable({$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);
}
}
Jump to Line
Something went wrong with that request. Please try again.