TbToggleColumn.php

Go to the documentation of this file.

<?php
class TbToggleColumn extends TbDataColumn {

        public $value;

        public $name;

        public $htmlOptions = array('class' => 'toggle-column');

        public $headerHtmlOptions = array('class' => 'toggle-column');

        public $footerHtmlOptions = array('class' => 'toggle-column');

        public $checkedButtonLabel;

        public $uncheckedButtonLabel;

        public $emptyButtonLabel;

        public $checkedIcon = 'ok-circle';

        public $uncheckedIcon = 'remove-sign';

        public $emptyIcon = 'question-sign';

        public $displayText = false;

        public $sortable = true;

        public $filter;

        public $toggleAction = 'toggle';

        public $afterToggle;

        public $uniqueClassSuffix = '';

        protected $button = array();

        public function init()
        {
                if ($this->name === null) {
                        throw new CException(Yii::t(
                                'zii',
                                '"{attribute}" attribute cannot be empty.',
                                array('{attribute}' => "name")
                        ));
                }

                $this->initButton();
                $this->registerClientScript();
        }

        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->emptyButtonLabel === null) {
                        $this->emptyButtonLabel = Yii::t('zii', 'Not set');
                }

                $this->button = array(
                        'url' => 'Yii::app()->controller->createUrl("' . $this->toggleAction . '",array("pk"=>$data->primaryKey,"attribute"=>"' . $this->name . '"))',
                        'htmlOptions' => array('class' => $this->name . '_toggle' . $this->uniqueClassSuffix),
                );

                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;
}";
        }

        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));
                }
        }

        protected function renderDataCellContent($row, $data) {
                
                $checked = ($this->value === null)
                        ? CHtml::value($data, $this->name)
                        : $this->evaluateExpression($this->value, array('data' => $data, 'row' => $row));

                $button = $this->button;
                $button['icon'] = $checked === null ? $this->emptyIcon : ($checked ? $this->checkedIcon : $this->uncheckedIcon);
                $button['url'] = isset($button['url']) ? $this->evaluateExpression(
                        $button['url'],
                        array('data' => $data, 'row' => $row)
                ) : '#';

                if (!$this->displayText) {
                        $button['htmlOptions']['title'] = $this->getButtonLabel($checked);
            if (!isset($button['htmlOptions']['data-toggle'])) {
                $button['htmlOptions']['data-toggle'] = 'tooltip';
            }
                        echo CHtml::link('<span class="glyphicon glyphicon-' . $button['icon'] . '"></span>', $button['url'], $button['htmlOptions']);
                } else {
                        $button['label'] = $this->getButtonLabel($checked);
                        $button['class'] = 'booster.widgets.TbButton';
                        $widget = Yii::createComponent($button);
                        $widget->init();
                        $widget->run();
                }
        }

        private function getButtonLabel($value) {
                
                return $value === null ? $this->emptyButtonLabel : ($value ? $this->checkedButtonLabel : $this->uncheckedButtonLabel);
        }
}