Fuman
\

\app_core_component_filter_preference

Filter preference component

Summary

Methods
Properties
Constants
__construct()
loadDefaults()
loadUserPreference()
getCurrentSetName()
setCurrentSetTo()
hasSet()
indexOfSetName()
getSetByName()
deleteSet()
resetSet()
getSetByIndex()
rearrangeSets()
setValue()
hasValue()
getValue()
getSets()
save()
getFilterSet()
getSelectSetParamKey()
getResetFilterUri()
getNotification()
getFilterSetComponents()
getFilterSetComponent()
No public properties found
DEFAULT_SET_NAME
SESSION_CONTAINER_KEY
KEY_FILTER_CONFIG
_buildOpenedSet()
_buildClosedSet()
_getButtons()
_autoHealth()
$_key
$_user
$_currentSetName
$_currentSetIndex
$_currentSet
$_sets
$_buttons
$_sessionContainer
N/A
No private methods found
No private properties found
N/A

Constants

DEFAULT_SET_NAME

DEFAULT_SET_NAME

SESSION_CONTAINER_KEY

SESSION_CONTAINER_KEY

KEY_FILTER_CONFIG

KEY_FILTER_CONFIG

Properties

$_key

$_key :

Type

$_user

$_user :

Type

$_currentSetName

$_currentSetName :

Type

$_currentSetIndex

$_currentSetIndex :

Type

$_currentSet

$_currentSet :

Type

$_sets

$_sets : array

Type

array

$_buttons

$_buttons :

Type

$_sessionContainer

$_sessionContainer :

Type

Methods

__construct()

__construct(string  $key)

Constructor

Parameters

string $key

loadDefaults()

loadDefaults()

Loads defaults

loadUserPreference()

loadUserPreference(\stdClass  $preference)

Load users preferences

Parameters

\stdClass $preference

getCurrentSetName()

getCurrentSetName() : string

returns the name of the current filterSet

Returns

string

setCurrentSetTo()

setCurrentSetTo(object  $set)

Sets current set to

Parameters

object $set

hasSet()

hasSet(string  $setName) : boolean

Has set

Parameters

string $setName

Returns

boolean

indexOfSetName()

indexOfSetName(string  $setName) : integer

Index of set name

Parameters

string $setName

Returns

integer

getSetByName()

getSetByName(string  $setName) : object|null

Gets set by name

Parameters

string $setName

Returns

object|null

deleteSet()

deleteSet(string  $setName)

Delete set

Parameters

string $setName

resetSet()

resetSet(object  $set)

Reset set

Parameters

object $set

getSetByIndex()

getSetByIndex(integer  $index) : mixed

Gets set by index

Parameters

integer $index

Returns

mixed

rearrangeSets()

rearrangeSets(  $newPosition,   $name) : boolean

Rearrange the sets

Parameters

$newPosition
$name

Returns

boolean

setValue()

setValue(string  $key, string  $value, null|string  $setName = null) : string

Sets value

Parameters

string $key
string $value
null|string $setName

Returns

string

hasValue()

hasValue(string  $key, null|string  $setName = null) : boolean

Has value

Parameters

string $key
null|string $setName

Returns

boolean

getValue()

getValue(string  $key, null|string  $setName = null) : string|null

Get value

Parameters

string $key
null|string $setName

Returns

string|null

getSets()

getSets() : array

Returns

array

save()

save()

Save

getFilterSet()

getFilterSet(null  $name = null, null  $filterConfigs = null) : \app_core_component_filter_filterset

Gets filter set

Parameters

null $name
null $filterConfigs

Returns

\app_core_component_filter_filterset

getSelectSetParamKey()

getSelectSetParamKey() : string

Returns the key for the param which holds the set identifier

Returns

string

getResetFilterUri()

getResetFilterUri(\stdClass  $uriParams) : string

Returns the reset url for the given filter

Parameters

\stdClass $uriParams

Returns

string

getNotification()

getNotification(string  $resetFilterUri) : \Fuman_Response_Data

Gets notification

Parameters

string $resetFilterUri

Returns

\Fuman_Response_Data

getFilterSetComponents()

getFilterSetComponents(array  $filters) : array

Gets filter set components

Parameters

array $filters

Returns

array

getFilterSetComponent()

getFilterSetComponent(null|string  $name = null, array|null  $filters = null) : \Fuman_Response_Data

Gets filter set componenents

Parameters

null|string $name
array|null $filters

Returns

\Fuman_Response_Data

_buildOpenedSet()

_buildOpenedSet(string  $setName, array  $filters) : \Fuman_Response_Data

Build opened set

Parameters

string $setName
array $filters

Returns

\Fuman_Response_Data

_buildClosedSet()

_buildClosedSet(string  $setName) : \Fuman_Response_Data

Build closed set

Parameters

string $setName

Returns

\Fuman_Response_Data

_getButtons()

_getButtons() : \stdClass

Gets buttons

Returns

\stdClass

_autoHealth()

_autoHealth()

for backward compatiblity and auto health