GemsTracker library API
Back to top  

Keeps and reuse earlier request parameters in session cache

package Gems
subpackage Util
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.2
deprecated since 1.7.2
inherited_from \Gems_Registry_TargetAbstract

 Methods

__construct() 

__construct(string $sourceAction = null, boolean $readonly = false) 

Parameters

$sourceAction

string

The action to get the cache from if not the current one.

$readonly

boolean

Optional, tell the cache not to store any new values

Returns a callable if a method is called as a variable

__get(string $name) : Callable
Inherited

Parameters

$name

string

Returns

Callable

Should be called after answering the request to allow the Target to check if all required registry values have been set correctly.

checkRegistryRequestsAnswers() : boolean

Returns

booleanFalse if required are missing.

getBaseUrl() 

getBaseUrl() : array

Returns

array

getCachedRequest() 

getCachedRequest() : array

Returns

array

getProgramParams() 

getProgramParams() : array

Returns

array

removeParams() 

removeParams(string $key_arg1) : \Gems_Util_RequestCache

Parameters

$key_arg1

string

First of optionally many arguments

Returns

\Gems_Util_RequestCache

setMenu() 

setMenu(\Gems_Menu $menu) : \Gems_Util_RequestCache

Parameters

$menu

\Gems_Menu

Returns

\Gems_Util_RequestCache(continuation pattern)

Set the keys stored fot this cache

setProgramParams(array $programParams) : \Gems_Util_RequestCache

Parameters

$programParams

array

Returns

\Gems_Util_RequestCache(continuation pattern)

Makes sure any new values in the request are not written to the cache.

setReadonly(\boolen $value = true) : \Gems_Util_RequestCache

Parameters

$value

\boolen

Returns

\Gems_Util_RequestCache(continuation pattern)

setRequest() 

setRequest(\Zend_Controller_Request_Abstract $request) : \Gems_Util_RequestCache

Parameters

$request

\Zend_Controller_Request_Abstract

Returns

\Gems_Util_RequestCache(continuation pattern)

Set the actiuon to use instead of the current one.

setSourceAction(string $action) : \Gems_Util_RequestCache

Parameters

$action

string

Returns

\Gems_Util_RequestCache(continuation pattern)

getMenu() 

getMenu() : \Gems_Menu

Returns

\Gems_Menu

getRequest() 

getRequest() : \Zend_Controller_Request_Abstract

Returns

\Zend_Controller_Request_Abstract

The module / controller /action of the request in an array.

getRequestKey() : array

Returns

array

getStorageKey() 

getStorageKey() : string

Returns

stringKey identifying the current request

 Properties

 

$_baseUrl

$_baseUrl : array

Default

 

$_programParams

$_programParams : array

Default

array()
 

True if the cache should not be written to.

$_readonly : boolean

Default

false
 

The module / controller /action of the request in an array.

$_requestKey : array

Default

 

String identifying the current module / controller /action of the request.

$_storageKey : string

Default

 

$menu

$menu : \Gems_Menu

Default

 

$request

$request : \Zend_Controller_Request_Abstract

Default

 

$session

$session : \Zend_Session_Namespace

Default

 

Optional different action to use from that of the current request

$sourceAction : string

Default

 Constants

 

Url parameter to reset

RESET_PARAM = 'reset'