* * @author: antonio ramirez * Date: 10/16/12 * Time: 6:15 PM */ Yii::import('zii.widgets.grid.CGridColumn'); class TbToggleColumn extends CGridColumn { /** * @var string the attribute name of the data model. Used for column sorting, filtering and to render the corresponding * attribute value in each data cell. If {@link value} is specified it will be used to rendered the data cell instead of the attribute value. * @see value * @see sortable */ public $name; /** * @var array the HTML options for the data cell tags. */ public $htmlOptions = array('class' => 'toggle-column'); /** * @var array the HTML options for the header cell tag. */ public $headerHtmlOptions = array('class' => 'toggle-column'); /** * @var array the HTML options for the footer cell tag. */ public $footerHtmlOptions = array('class' => 'toggle-column'); /** * @var string the label for the toggle button. Defaults to "Check". * Note that the label will not be HTML-encoded when rendering. */ public $checkedButtonLabel; /** * @var string the label for the toggle button. Defaults to "Uncheck". * Note that the label will not be HTML-encoded when rendering. */ public $uncheckedButtonLabel; /** * @var string the glyph icon toggle button "checked" state. * You may set this property to be false to render a text link instead. */ public $checkedIcon = 'icon-ok-circle'; /** * @var string the glyph icon toggle button "unchecked" state. * You may set this property to be false to render a text link instead. */ public $uncheckedIcon = 'icon-remove-sign'; /** * @var boolean whether the column is sortable. If so, the header cell will contain a link that may trigger the sorting. * Defaults to true. Note that if {@link name} is not set, or if {@link name} is not allowed by {@link CSort}, * this property will be treated as false. * @see name */ public $sortable = true; /** * @var mixed the HTML code representing a filter input (eg a text field, a dropdown list) * that is used for this data column. This property is effective only when * {@link CGridView::filter} is set. * If this property is not set, a text field will be generated as the filter input; * If this property is an array, a dropdown list will be generated that uses this property value as * the list options. * If you don't want a filter for this data column, set this value to false. * @since 1.1.1 */ public $filter; /** * @var string Name of the action to call and toggle values * @see bootstrap.action.TbToggleAction for an easy way to use with your controller */ public $toggleAction; /** * @var string a javascript function that will be invoked after the toggle ajax call. * * The function signature is function(data) * * Note that if success is true it does not mean that the delete was successful, it only means that the ajax call was successful. * * Example: * 
	 *  array(
	 *     class'=>'TbToggleColumn',
	 *     'afterDelete'=>'function(success,data){ if(success) alert("Toggled successfuly"); }',
	 *  ),
	 *
*/ public $afterToggle; /** * @var array the configuration for toggle button. */ protected $button = array(); /** * Initializes the column. * This method registers necessary client script for the button column. */ public function init() { if ($this->name === null) throw new CException(Yii::t('zii', '"{attribute}" attribute cannot be empty.', array('{attribute}'=>"name"))); if($this->toggleAction === null) throw new CException(Yii::t('zii', '"{attribute}" attribute cannot be empty.', array('{attribute}'=>"toggleAction"))); $this->initButton(); $this->registerClientScript(); } /** * Initializes the default buttons (toggle). */ protected function initButton() { if ($this->checkedButtonLabel === null) $this->checkedButtonLabel = Yii::t('zii', 'Uncheck'); if ($this->uncheckedButtonLabel === null) $this->uncheckedButtonLabel = Yii::t('zii', 'Check'); if ($this->checkedIcon === null) $this->checkedIcon = 'icon-ok-circle'; if ($this->uncheckedIcon === null) $this->uncheckedIcon = 'icon-remove-sign'; $this->button = array( 'url' => 'Yii::app()->controller->createUrl("' . $this->toggleAction . '",array("id"=>$data->primaryKey,"attribute"=>"' . $this->name . '"))', 'htmlOptions' => array('class' => $this->name . '_toggle'), ); if (Yii::app()->request->enableCsrfValidation) { $csrfTokenName = Yii::app()->request->csrfTokenName; $csrfToken = Yii::app()->request->csrfToken; $csrf = "\n\t\tdata:{ '$csrfTokenName':'$csrfToken' },"; } else $csrf = ''; if($this->afterToggle===null) $this->afterToggle='function(){}'; $this->button['click'] = "js: function() { var th=this; var afterToggle={$this->afterToggle}; $.fn.yiiGridView.update('{$this->grid->id}', { type:'POST', url:$(this).attr('href'),{$csrf} success:function(data) { $.fn.yiiGridView.update('{$this->grid->id}'); afterToggle(true, data); }, error:function(XHR){ afterToggle(false,XHR); } }); return false; }"; } /** * Registers the client scripts for the button column. */ protected function registerClientScript() { $js = array(); $function = CJavaScript::encode($this->button['click']); unset($this->button['click']); $class = preg_replace('/\s+/', '.', $this->button['htmlOptions']['class']); $js[] = "$(document).on('click','#{$this->grid->id} a.{$class}',$function);"; if ($js !== array()) Yii::app()->getClientScript()->registerScript(__CLASS__ . '#' . $this->id, implode("\n", $js)); } /** * Renders the data cell content. * This method renders the view, update and toggle buttons in the data cell. * @param integer $row the row number (zero-based) * @param mixed $data the data associated with the row */ protected function renderDataCellContent($row, $data) { $checked = CHtml::value($data, $this->name); $button = $this->button; $button['icon'] = $checked ? $this->checkedIcon : $this->uncheckedIcon; $button['label'] = $checked ? $this->checkedButtonLabel : $this->uncheckedButtonLabel; $button['url'] = isset($button['url']) ? $this->evaluateExpression($button['url'], array('data' => $data, 'row' => $row)) : '#'; $button['class'] = 'bootstrap.widgets.TbButton'; $widget = Yii::createComponent($button); $widget->init(); $widget->run(); } /** * Renders the header cell content. * This method will render a link that can trigger the sorting if the column is sortable. */ protected function renderHeaderCellContent() { if ($this->grid->enableSorting && $this->sortable && $this->name !== null) echo $this->grid->dataProvider->getSort()->link($this->name, $this->header, array('class' => 'sort-link')); else if ($this->name !== null && $this->header === null) { if ($this->grid->dataProvider instanceof CActiveDataProvider) echo CHtml::encode($this->grid->dataProvider->model->getAttributeLabel($this->name)); else echo CHtml::encode($this->name); } else parent::renderHeaderCellContent(); } /** * Renders the filter cell content. * This method will render the {@link filter} as is if it is a string. * If {@link filter} is an array, it is assumed to be a list of options, and a dropdown selector will be rendered. * Otherwise if {@link filter} is not false, a text field is rendered. * @since 1.1.1 */ protected function renderFilterCellContent() { if ($this->filter !== null) { if (is_string($this->filter)) echo $this->filter; else if ($this->filter !== false && $this->grid->filter !== null && $this->name !== null && strpos($this->name, '.') === false) { if (is_array($this->filter)) echo CHtml::activeDropDownList($this->grid->filter, $this->name, $this->filter, array('id' => false, 'prompt' => '')); else if ($this->filter === null) echo CHtml::activeTextField($this->grid->filter, $this->name, array('id' => false)); } else parent::renderFilterCellContent(); } } }