TbExtendedFilter Class Reference

Public Member Functions
	init ()
	run ()
	registerClientScript ()

Public Attributes
	$model
	$grid
	$saveFilterVar = 'saveFilterAs'
	$removeFilterVar = 'removeFilter'
	$filteredBy
	$redirectRoute

Protected Member Functions
	checkRequestRemovalFilter ()
	checkRequestFilters ()
	displaySaveButton ($registryKey)
	displaySavedFilters ($registryKey)
	generateRegistryItemKey ()
	displayExtendedFilterValues ($filteredBy)

Protected Attributes
	$registry = 'extended-filter'
	$jsonStorage

Detailed Description

Definition at line 20 of file TbExtendedFilter.php.

Member Function Documentation

TbExtendedFilter::checkRequestFilters ( )

protected

.checkRequestFilters()

Checkes whether there has been send the command to save a filter to the registry and redirects to specified route

Returns

bool

Definition at line 123 of file TbExtendedFilter.php.

Here is the call graph for this function:

Here is the caller graph for this function:

TbExtendedFilter::checkRequestRemovalFilter ( )

protected

.checkRequestRemovalFilter()

Checks whether there has been send the command to remove a filter from the registry and redirects to specified route

Definition at line 106 of file TbExtendedFilter.php.

Here is the caller graph for this function:

TbExtendedFilter::displayExtendedFilterValues (   $filteredBy )

protected

.displayExtendedFilterValues()

Displays the filtered options

Parameters

array

$filteredBy

Returns

string

Definition at line 312 of file TbExtendedFilter.php.

Here is the caller graph for this function:

TbExtendedFilter::displaySaveButton (   $registryKey )

protected

.displaySaveButton()

Displays the save filter button

Parameters

string

$registryKey

Definition at line 232 of file TbExtendedFilter.php.

Here is the caller graph for this function:

TbExtendedFilter::displaySavedFilters (   $registryKey )

protected

.displaySavedFilters()

displays the saved filters as a dropdown list

Parameters

string

$registryKey

Definition at line 251 of file TbExtendedFilter.php.

Here is the caller graph for this function:

TbExtendedFilter::generateRegistryItemKey ( )

protected

.generateRegistryItemKey()

Generates a registry item key with the filtered attributes + the grid id

Returns

null|string

Definition at line 295 of file TbExtendedFilter.php.

Here is the caller graph for this function:

TbExtendedFilter::init

(

)

.init()

Widget initialization

Exceptions

CException

Definition at line 68 of file TbExtendedFilter.php.

Here is the call graph for this function:

TbExtendedFilter::registerClientScript

(

)

.registerClientScript()

Registers the required

Definition at line 180 of file TbExtendedFilter.php.

Here is the caller graph for this function:

TbExtendedFilter::run

(

)

.run()

Widget's run method

Definition at line 149 of file TbExtendedFilter.php.

Here is the call graph for this function:

Member Data Documentation

TbExtendedFilter::$filteredBy

Definition at line 50 of file TbExtendedFilter.php.

TbExtendedFilter::$grid

Definition at line 30 of file TbExtendedFilter.php.

TbExtendedFilter::$jsonStorage

protected

Definition at line 60 of file TbExtendedFilter.php.

TbExtendedFilter::$model

Definition at line 25 of file TbExtendedFilter.php.

TbExtendedFilter::$redirectRoute

Definition at line 55 of file TbExtendedFilter.php.

TbExtendedFilter::$registry = 'extended-filter'

protected

Definition at line 35 of file TbExtendedFilter.php.

TbExtendedFilter::$removeFilterVar = 'removeFilter'

Definition at line 45 of file TbExtendedFilter.php.

TbExtendedFilter::$saveFilterVar = 'saveFilterAs'

Definition at line 40 of file TbExtendedFilter.php.

---

The documentation for this class was generated from the following file:

• app/protected/extensions/booster/widgets/TbExtendedFilter.php