Class SessionFilterComponent

SessionFilterComponent class

Handle filter session used to list BEdita objects. The session key used to store filter is usually built as self::$sessionKeyPrefix . '.ControllerName.actionName'

Object

Extended by

SessionFilterComponent

Located at controllers/components/session_filter.php

Methods summary

`public`	# `initialize( Controller & $controller, array $settings = array() )` initialize component initialize component Parameters `$controller` `$settings`
`public`	# `startup( Controller & $controller )` startup component startup component starts the setup in BEdita backend for frontend apps the setup starts in FrontendController::route() if the config var 'enableSessionFilter' is set to true Parameters `$controller`
`public`	# `setup( string $name = null )` setup Session Filter setup Session Filter setup self::sessionKey clean filter if not empty $controller->params['form']['cleanFilter'] if not to clean, setup filter if not empty $controller->params['form']['filter'] Parameters `$name` suffix to assign to session key if empty ControllerName.actionName was used
`private`	# `setSessionKey( string $name = null )` set session key prefixing it with self::sessionKeyPrefix set session key prefixing it with self::sessionKeyPrefix Parameters `$name` suffix to assign to session key if empty ControllerName.actionName was used
`public string`	# `which( )` return filter session key return filter session key Returns string
`public array`	# `getFromUrl( )` get filter from url only named params inside self::urlArgsAccepted will be returned get filter from url only named params inside self::urlArgsAccepted will be returned Returns array
`public`	# `setFromUrl( boolean $merge = true )` setup filter session reading some params from url setup filter session reading some params from url Parameters `$merge` true to merge with existing filter (default) false to override all filter
`public`	# `add( string $key, mixed $value )` add a key to current filter session add a key to current filter session Parameters `$key` `$value`
`public`	# `addBulk( array $filter, boolean $merge = false )` add bulk filters to session add bulk filters to session Parameters `$filter` array of filters to add `$merge` false to override old filter (default) true to merge with old filter
`public`	# `arrange( array & $filter )` arrange data before insert in session empty values are removed arrange data before insert in session empty values are removed Parameters `$filter`
`public array`	# `read( string $key = null )` read a filter key read a filter key Parameters `$key` Returns array
`public boolean`	# `delete( string $key )` delete a key from filter delete a key from filter Parameters `$key` Returns boolean true if session variable is set and can be deleted, false if variable was not set
`public boolean`	# `clean( )` clean self::$sessionKey from session clean self::$sessionKey from session Returns boolean true if session variable is set and can be deleted, false if variable was not set
`public boolean`	# `cleanAll( )` clean all filter in session clean all filter in session Returns boolean true if session variable is set and can be deleted, false if variable was not set

Properties summary

`public array`	`$components` list of components used list of components used	# `array('Session')`
`public Controller`	`$controller` the controller that use this component the controller that use this component	# `null`
`private string`	`$sessionKeyPrefix` the session key prefix the session key prefix	# `'beditaFilter'`
`private string`	`$sessionKey` the session key used to store filter. It's usually built as self::$sessionKeyPrefix . '.ControllerName.actionName' the session key used to store filter. It's usually built as self::$sessionKeyPrefix . '.ControllerName.actionName'	# `null`
`private array`	`$urlArgsAccepted` url args that are accepted to be put in session filter used in self::getFromUrl() method url args that are accepted to be put in session filter used in self::getFromUrl() method	# `array( 'id', 'category', 'relation', 'rel_object_id', 'rel_detail', 'comment_object_id', 'mail_group', 'tag', 'query', 'substring', 'status' )`