ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / letacommog / letaweb / protected / extensions / yiibooster / widgets

<?php
/**
 *## TbExtendedFilter widget
 *
 * @author Antonio Ramirez <antonio@clevertech.biz>
 * @copyright Copyright &copy; Clevertech 2012-
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 */

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

/**
 *## Extended filter for grids.
 *
 * This widget displays an extra row to the grid is attached to and renders a visual feedback of the filter values used
 * plus an option to save them for later use.
 *
 * @package booster.widgets.supplementary
 */
class TbExtendedFilter extends CWidget {
	
	/**
	 * @var CActiveRecord the model that works as a filter to the grid
	 */
	public $model;

/**
	 * @var CGridView the grid view the widget is going to be used with
	 */
	public $grid;

/**
	 * @var string the name of the json registry to save the value
	 */
	protected $registry = 'extended-filter';

/**
	 * @var string the ajax variable that is used to check whether a filter is to be saved
	 */
	public $saveFilterVar = 'saveFilterAs';

/**
	 * @var string the ajax variable that is used to check whether to delete a filter from the registry
	 */
	public $removeFilterVar = 'removeFilter';

/**
	 * @var array the cleaned filter attributes
	 */
	public $filteredBy;

/**
	 * @var array the route to redirect when saving/removing a filter
	 */
	public $redirectRoute;

/**
	 * @var JSONStorage Component
	 */
	protected $jsonStorage;

/**
	 *### .init()
	 *
	 * Widget initialization
	 * @throws CException
	 */
	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();
	}

/**
	 *### .checkRequestRemovalFilter()
	 *
	 * Checks whether there has been send the command to remove a filter from the registry and redirects to
	 * specified route
	 */
	protected function checkRequestRemovalFilter() {
		
		if ($key = Yii::app()->getRequest()->getParam($this->removeFilterVar)) {
			if ($this->jsonStorage->removeData($key, $this->registry)) {
				Yii::app()->getController()->redirect($this->redirectRoute);
			}
		}
	}

/**
	 *### .checkRequestFilters()
	 *
	 * Checkes whether there has been send the command to save a filter to the registry and redirects to
	 * specified route
	 *
	 * @return bool
	 */
	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;
	}

/**
	 *### .run()
	 *
	 * Widget's run method
	 */
	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";
	}

/**
	 *### .registerClientScript()
	 *
	 * Registers the required
	 */
	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
		);
	}

/**
	 *### .displaySaveButton()
	 *
	 * Displays the save filter button
	 *
	 * @param string $registryKey
	 */
	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');
	}

/**
	 *### .displaySavedFilters()
	 *
	 * displays the saved filters as a dropdown list
	 *
	 * @param string $registryKey
	 */
	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>';
		}
	}

/**
	 *### .generateRegistryItemKey()
	 *
	 * Generates a registry item key with the filtered attributes + the grid id
	 *
	 * @return null|string
	 */
	protected function generateRegistryItemKey() {
		
		if (!count($this->filteredBy)) {
			return null;
		}
		return md5($this->grid->id . CJSON::encode($this->filteredBy));
	}

/**
	 *### .displayExtendedFilterValues()
	 *
	 * Displays the filtered options
	 *
	 * @param array $filteredBy
	 *
	 * @return string
	 */
	protected function displayExtendedFilterValues($filteredBy) {
		
		$values = array();
		foreach ($filteredBy as $key => $value) {
			$values[] = '<span class="label label-info">' . $key . '</span> ' . $value;
		}
		return implode(', ', $values);
	}
}

[+] ..
[-] TbTabView.php [edit]
[-] TbNavbar.php [edit]
[-] TbHighCharts.php [edit]
[-] TbPager.php [edit]
[-] TbLabel.php [edit]
[-] TbActiveForm.php [edit]
[-] TbPanel.php [edit]
[-] TbJsonButtonColumn.php [edit]
[-] TbModalManager.php [edit]
[-] TbToggleColumn.php [edit]
[-] TbUiLayout.php [edit]
[-] TbBaseMenu.php [edit]
[-] widgets.md [edit]
[-] TbEditableDetailView.php [edit]
[-] TbButtonGroup.php [edit]
[-] TbEditable.php [edit]
[-] TbFileUpload.php [edit]
[-] TbEditableField.php [edit]
[-] TbTags.php [edit]
[-] TbFormButtonElement.php [edit]
[-] TbFormInputElement.php [edit]
[-] TbJsonPager.php [edit]
[-] TbCollapse.php [edit]
[-] TbBulkActions.php [edit]
[-] TbRelationalColumn.php [edit]
[-] TbTabs.php [edit]
[-] TbModal.php [edit]
[-] TbExtendedGridView.php [edit]
[-] TbJumbotron.php [edit]
[-] TbImageGallery.php [edit]
[-] TbWidget.php [edit]
[-] TbMenu.php [edit]
[-] TbProgress.php [edit]
[-] TbButtonColumn.php [edit]
[-] TbJsonToggleColumn.php [edit]
[-] TbJsonPickerColumn.php [edit]
[-] TbColorPicker.php [edit]
[-] TbButtonGroupColumn.php [edit]
[-] TbSwitch.php [edit]
[-] TbHeroUnit.php [edit]
[-] TbDatePicker.php [edit]
[-] TbJsonCheckBoxColumn.php [edit]
[-] TbButton.php [edit]
[-] TbTypeahead.php [edit]
[-] TbForm.php [edit]
[-] TbPassfield.php [edit]
[-] TbEditableColumn.php [edit]
[-] TbMarkdownEditorJs.php [edit]
[-] TbPopoverColumn.php [edit]
[-] TbMarkdownEditor.php [edit]
[-] TbAlert.php [edit]
[-] TbGroupGridView.php [edit]
[-] TbBaseInputWidget.php [edit]
[-] TbWizard.php [edit]
[-] TbGroupButtonColumn.php [edit]
[-] TbExtendedFilter.php [edit]
[-] TbGoogleVisualizationChart.php [edit]
[-] TbHtml5Editor.php [edit]
[-] TbGridView.php [edit]
[-] TbListView.php [edit]
[-] TbTimePicker.php [edit]
[-] TbJsonGridView.php [edit]
[-] TbCKEditor.php [edit]
[-] TbTotalSumColumn.php [edit]
[-] TbDateRangePicker.php [edit]
[-] TbBadge.php [edit]
[-] TbDropdown.php [edit]
[-] TbBreadcrumbs.php [edit]
[-] TbJsonGridColumn.php [edit]
[-] TbDateTimePicker.php [edit]
[-] TbDataColumn.php [edit]
[-] TbCarousel.php [edit]
[-] TbJsonDataColumn.php [edit]
[-] TbRedactorJs.php [edit]
[-] TbThumbnails.php [edit]
[-] TbScrollSpy.php [edit]
[-] TbDetailView.php [edit]
[+] input
[-] TbSelect2.php [edit]
[-] TbImageColumn.php [edit]