TbExtendedFilter.php

Go to the documentation of this file.

<?php
Yii::import('booster.components.JSONStorage', true);

class TbExtendedFilter extends CWidget {
        
        public $model;

        public $grid;

        protected $registry = 'extended-filter';

        public $saveFilterVar = 'saveFilterAs';

        public $removeFilterVar = 'removeFilter';

        public $filteredBy;

        public $redirectRoute;

        protected $jsonStorage;

        public function init() {
                
                if (!$this->model instanceof CActiveRecord) {
                        throw new CException(Yii::t('zii', '"model" attribute must be an CActiveRecord type of component'));
                }

                if (!$this->grid instanceof CGridView) {
                        throw new CException(Yii::t('zii', '"grid" attribute must be an CGridView type of component'));
                }

                if (!$this->redirectRoute === null) {
                        throw new CException(Yii::t('zii', '"redirectRoute" cannot be empty'));
                }

                $this->registry .= '-' . $this->grid->id;

                $this->jsonStorage = new JSONStorage();
                $this->jsonStorage->addRegistry($this->registry);

                $this->filteredBy = array_filter(
                        $this->model->getAttributes(),
                        function ($i) {
                                return $i != null;
                        }
                );

                $this->checkRequestRemovalFilter();
                $this->checkRequestFilters();

                $this->registerClientScript();
        }

        protected function checkRequestRemovalFilter() {
                
                if ($key = Yii::app()->getRequest()->getParam($this->removeFilterVar)) {
                        if ($this->jsonStorage->removeData($key, $this->registry)) {
                                Yii::app()->getController()->redirect($this->redirectRoute);
                        }
                }
        }

        protected function checkRequestFilters()
        {
                $filterName = Yii::app()->getRequest()->getParam($this->saveFilterVar);
                if (!$filterName)
                        return false;

                if (!count($this->filteredBy))
                        return false;

                $key = $this->generateRegistryItemKey();
                if ($this->jsonStorage->getData($key, $this->registry))
                        return false;

                $data = array('name' => $filterName);
                $data['options'] = array(get_class($this->model) => $this->filteredBy);
                $this->jsonStorage->setData($key, $data, $this->registry);

                Yii::app()->getController()->redirect($this->redirectRoute);
                return true;
        }

        public function run() {

                $registryKey = $this->generateRegistryItemKey($this->filteredBy);

                if (!count($this->filteredBy) && !$this->jsonStorage->getLength($this->registry)) {
                        return;
                }

                echo "<tr>\n";
                $cols = count($this->grid->columns);
                echo "<td colspan='{$cols}'>\n";
                echo "<div id='{$this->getId()}'>\n";
                if (count($this->filteredBy)) {
                        echo '<p><span class="label label-success">Filtered by</span> ' . $this->displayExtendedFilterValues(
                                $this->filteredBy
                        ) . '</p>';
                }

                $this->displaySaveButton($registryKey);
                $this->displaySavedFilters($registryKey);

                echo "</div>\n";
                echo "</td>\n";
                echo "</tr>\n";
        }

        public function registerClientScript() {
                
                $url = CHtml::normalizeUrl($this->redirectRoute);

                Yii::app()->clientScript->registerScript(
                        __CLASS__ . '#extended-filter' . $this->grid->id,
                        <<<EOD
                        $(document).on('click', '#{$this->grid->id} .btn-extended-filter-save', function(e){
                        e.preventDefault();
                        bootbox.prompt("How do you wish to save this filter?", function(result){
                                if ($.trim(result).length > 0)
                                {
                                        $('#{$this->grid->id}').yiiGridView('update',{data:{{$this->saveFilterVar}:result}});
                                }
                        });
                });
                $(document).on('click', '#{$this->grid->id} .btn-extended-filter-apply', function(e) {
                        e.preventDefault();
                        var option = $('#{$this->getId()} select.select-extended-filter option:selected');
                        if (!option.length || !option.data('filter')) {
                                return false;
                        }
                        var data ={data:option.data('filter')};
                        if (option.val()==-1) {
                                data.url = "{$url}";
                        }
                        $('#{$this->grid->id}').yiiGridView('update',data);
                });

                $(document).on('click', '#{$this->grid->id} .btn-extended-filter-delete', function(e) {
                        e.preventDefault();
                        var option = $('#{$this->grid->id} select.select-extended-filter option:selected');
                        if (!option.length || !option.data('key') || option.val()==-1) {
                                return false;
                        }
                        bootbox.confirm('Delete "'+option.text()+'" filter?', function(confirmed){
                                if (confirmed) {
                                        $('#{$this->grid->id}').yiiGridView('update',{data:{{$this->removeFilterVar}:option.data('key')}});
                                }
                        });
                });
EOD
                );
        }

        protected function displaySaveButton($registryKey) {
                
                if (null == $registryKey || $this->jsonStorage->getData($registryKey, $this->registry))
                        return;

                echo CHtml::openTag('p');

                echo CHtml::link('save filter', '#', array('class' => 'btn btn-success btn-extended-filter-save'));

                echo CHtml::closeTag('p');
        }

        protected function displaySavedFilters($registryKey) {
                
                if ($this->jsonStorage->getLength($this->registry)) {
                        $registry = $this->jsonStorage->getRegistry($this->registry);
                        echo '<div class="row">';
                        echo '<div class="col-md-6 col-sm-12" >';
                        echo '<label class="label label-info">Saved Filters [select and click ok sign button]</label><br/>';
                        echo '</div></div>';
                        echo '<div class="row" style="margin-top: 5px;">';
                        echo '<div class="col-md-6 col-sm-12" >';
                        echo '<select class="select-extended-filter">';
                        echo '<option value="-1" data-filter="{}" ' . (!$registryKey ? 'selected' : '') . '>No Filters</option>';
                        foreach ($registry as $key => $filter) {
                                echo CHtml::openTag(
                                        'option',
                                        array(
                                                'data-filter' => CJSON::encode($filter['options']),
                                                'data-key' => $key,
                                                'selected' => ($key == $registryKey ? 'selected' : null)
                                        )
                                );
                                echo $filter['name'];
                                echo '</option>';
                        }
                        echo '</select>&nbsp;';

                        echo CHtml::link(
                                '<i class="glyphicon glyphicon-ok glyphicon glyphicon-white"></i>',
                                '#',
                                array('class' => 'btn btn-primary btn-extended-filter-apply')
                        );
                        echo '&nbsp;';
                        echo CHtml::link('<i class="glyphicon glyphicon-trash"></i>', '#', array('class' => 'btn btn-warning btn-extended-filter-delete'));
                        echo '</div></div>';
                }
        }

        protected function generateRegistryItemKey() {
                
                if (!count($this->filteredBy)) {
                        return null;
                }
                return md5($this->grid->id . CJSON::encode($this->filteredBy));
        }

        protected function displayExtendedFilterValues($filteredBy) {
                
                $values = array();
                foreach ($filteredBy as $key => $value) {
                        $values[] = '<span class="label label-info">' . $key . '</span> ' . $value;
                }
                return implode(', ', $values);
        }
}