TbBulkActions.php

Go to the documentation of this file.

<?php
Yii::import('zii.widgets.grid.CCheckBoxColumn');
Yii::import('booster.widgets.TbButton');

class TbBulkActions extends CComponent {
        
    public $grid;

    public $actionButtons = array();

    public $checkBoxColumnConfig = array();
    
    public $noCheckedMessage = 'No items are checked';

    public $align = 'right';

    private static $_counter = 0;

    private $_id;

    public function getId($autoGenerate = true) {
        
        if ($this->_id !== null) {
            return $this->_id;
        } else if ($autoGenerate) {
            return $this->_id = 'egw' . self::$_counter++;
        } else {
                return ''; // why getId can sometimes return nothing ? because it is used in the jquery selector, so null is not an acceptable value 
        }
    }

    protected $columnName;

    protected $buttons = array();

    protected $events = array();

    public function __construct($grid) {
        
        $this->grid = $grid;
    }

    public function init() {
        
        $this->align = $this->align == 'left' ? 'pull-left' : 'pull-right';
        $this->initColumn();
        $this->initButtons();
    }

    public function initColumn() {
        
        if (!is_array($this->checkBoxColumnConfig)) {
            $this->checkBoxColumnConfig = array();
        }

        if (empty($this->grid->columns)) {
            return false;
        }

        $columns = $this->grid->columns;

        foreach ($columns as $idx => $column) {
            if (!is_array($column) || !isset($column['class'])) {
                continue;
            }
            if (preg_match('/ccheckboxcolumn/i', $column['class'])) {
                if (isset($column['checkBoxHtmlOptions']) && isset($column['checkBoxHtmlOptions']['name'])) {
                    $this->columnName = strtr(
                        $column['checkBoxHtmlOptions']['name'],
                        array('[' => "\\[", ']' => "\\]")
                    );
                } else {
                    $this->columnName = $this->grid->id . '_c' . $idx . '\[\]';
                }
                return true; // it has already a CCheckBoxColumn
            }
        }
        // not CCheckBoxColumn, attach one
        $this->attachCheckBoxColumn();
        return true;
    }

    public function initButtons() {
        
        if (empty($this->columnName) || empty($this->actionButtons))
            return;

            $this->buttons = array();
        foreach ($this->actionButtons as $action)
                $this->buttons[] = $this->convertToTbButtonConfig($action);
    }

    public function renderButtons() {
        
        if ($this->buttons === array())
            return false;

        echo CHtml::openTag(
            'div',
            array('id' => $this->getId(), 'style' => 'position:relative', 'class' => $this->align)
        );

        foreach ($this->buttons as $actionButton)
            $this->renderButton($actionButton);

        echo '<div style="position:absolute;top:0;left:0;height:100%;width:100%;display:block;" class="bulk-actions-blocker"></div>';

        echo CHtml::closeTag('div');

        $this->registerClientScript();
            return true;
    }

    public function registerClientScript() {
                $id = $this->grid->id;
        $js = '';
        $js .= "$.fn.yiiGridView.initBulkActions('{$id}');";

        foreach ($this->events as $buttonId => $handler) {
            $js .= "\n
            $(document).on('click','#{$buttonId}', function() {
                    var checked = $.fn.yiiGridView.getCheckedRowsIds('$id');
                    if (!checked.length) {
                        alert('".$this->noCheckedMessage."');
                        return false;
                    }
                                var fn = $handler;
                    if ($.isFunction(fn)){ fn(checked); } \n
                    return false;
                }); \n
            ";
        }
        Yii::app()->getClientScript()->registerScript(__CLASS__ . '#' . $this->getId(), $js);
    }

    protected function renderButton($actionButton) {
        
        if (isset($actionButton['htmlOptions']['class']))
            $actionButton['htmlOptions']['class'] .= ' disabled bulk-actions-btn';
        else
            $actionButton['htmlOptions']['class'] = 'disabled bulk-actions-btn';
        
        $action = null;
        if (isset($actionButton['click'])) {
            $action = CJavaScript::encode($actionButton['click']);
            unset($actionButton['click']);
        }

        $button = Yii::createComponent($actionButton);
        $button->init();
        echo '&nbsp;';
        $button->run();
        echo '&nbsp;';
        if ($action !== null) {
            $this->events[$button->id] = $action;
        }
    }

    protected function attachCheckBoxColumn() {
        
        $dataProvider = $this->grid->dataProvider;
        $columnName = null;

        if (!isset($this->checkBoxColumnConfig['name'])) {
            // supports two types of DataProviders
            if ($dataProvider instanceof CActiveDataProvider) {
                // we need to get the name of the key field 'by default'
                if (is_string($dataProvider->modelClass)) {
                    $modelClass = $dataProvider->modelClass;
                    $model = CActiveRecord::model($modelClass);
                } else {
                    $model = $dataProvider->modelClass;
                }

                $table = $model->tableSchema;
                if (is_string($table->primaryKey)) {
                    $columnName = $this->{$table->primaryKey};
                } else if (is_array($table->primaryKey)) {
                    $columnName = $table->primaryKey[0];
                } // just get the first one
            }
            if ($dataProvider instanceof CArrayDataProvider || $dataProvider instanceof CSqlDataProvider) {
                $columnName = $dataProvider->keyField;
            } // key Field
        }
        // create CCheckBoxColumn and attach to columns at its beginning
        $column = CMap::mergeArray(
            array(
                'class' => 'CCheckBoxColumn',
                'name' => $columnName,
            ),
            $this->checkBoxColumnConfig
        );


        array_unshift($this->grid->columns, $column);
        $this->columnName = $this->grid->id . '_c0\[\]'; //
    }

        private function convertToTbButtonConfig($action) {
                
                if (!isset($action['id'])) {
                        throw new CException(Yii::t(
                                'zii',
                                'Each bulk action button should have its "id" attribute set to ensure its functionality among ajax updates'
                        ));
                }
                // button configuration is a regular TbButton
                $buttonConfig = array(
                        'class' => 'booster.widgets.TbButton',
                        'id' => $action['id'], // we must ensure this
                        'buttonType' => isset($action['buttonType']) ? $action['buttonType'] : TbButton::BUTTON_LINK,
                        'context' => isset($action['context']) ? $action['context'] : '',
                        'size' => isset($action['size']) ? $action['size'] : TbButton::SIZE_SMALL,
                        'icon' => isset($action['icon']) ? $action['icon'] : null,
                        'label' => isset($action['label']) ? $action['label'] : null,
                        'url' => isset($action['url']) ? $action['url'] : null,
                        'active' => isset($action['active']) ? $action['active'] : false,
                        'items' => isset($action['items']) ? $action['items'] : array(),
                        'ajaxOptions' => isset($action['ajaxOptions']) ? $action['ajaxOptions'] : array(),
                        'htmlOptions' => isset($action['htmlOptions']) ? $action['htmlOptions'] : array(),
                        'encodeLabel' => isset($action['encodeLabel']) ? $action['encodeLabel'] : true,
                        'click' => isset($action['click']) ? $action['click'] : false
                );
                return $buttonConfig;
        }
}