CSStudioListCache
in package
The Cache container for record lists
Tags
Table of Contents
- CACHE_GROUP_FILTER = 'FilterInfo'
- CACHE_GROUP_SORT = 'SortInfo'
- CACHE_KEY_LISTDATA = 'StudioListCache'
- CACHE_PARAM_PARAMPREFIX = 'OldListParamPrefix'
- CACHE_PARAM_RECURSIVE = 'Recursive'
- CACHE_PARAM_SEARCHID = 'SearchID'
- __construct() : mixed
- Loads original cache during instantiation
- addGroupParameter() : mixed
- Adds a parameter into a group of the cache
- clearCache() : mixed
- Clears the cache
- getCacheKey() : string
- Fetches the unique key for accessing this cache
- getGroup() : array<string|int, mixed>
- Fetches the group from the cache
- getGroupParameter() : mixed
- Fetches the value for the group parameter from the cache
- getParameter() : mixed
- Fetches the parameter from the cache
- removeGroup() : mixed
- Removes the group from the cache
- removeGroupParameter() : mixed
- Removes the group parameter from the cache
- removeParameter() : mixed
- Removes the parameter from the cache
- saveInSession() : mixed
- Saves cache into Session
- setParameter() : mixed
- Sets a parameter into the cache
- toArray() : array<string|int, mixed>
- Fetches the array representation of the cache
Constants
CACHE_GROUP_FILTER
public
mixed
CACHE_GROUP_FILTER
= 'FilterInfo'
Tags
CACHE_GROUP_SORT
public
mixed
CACHE_GROUP_SORT
= 'SortInfo'
Tags
CACHE_KEY_LISTDATA
public
mixed
CACHE_KEY_LISTDATA
= 'StudioListCache'
Tags
CACHE_PARAM_PARAMPREFIX
public
mixed
CACHE_PARAM_PARAMPREFIX
= 'OldListParamPrefix'
Tags
CACHE_PARAM_RECURSIVE
public
mixed
CACHE_PARAM_RECURSIVE
= 'Recursive'
Tags
CACHE_PARAM_SEARCHID
public
mixed
CACHE_PARAM_SEARCHID
= 'SearchID'
Tags
Methods
__construct()
Loads original cache during instantiation
public
__construct(Record $oItem) : mixed
Parameters
- $oItem : Record
-
The item for which the cache is requested
Tags
Return values
mixed —addGroupParameter()
Adds a parameter into a group of the cache
public
addGroupParameter(string $sGroupName, string $sParameterName, mixed $mParameterValue) : mixed
Parameters
- $sGroupName : string
-
Group Name
- $sParameterName : string
-
Parameter Name
- $mParameterValue : mixed
-
Parameter Value
Tags
Return values
mixed —clearCache()
Clears the cache
public
clearCache() : mixed
Tags
Return values
mixed —getCacheKey()
Fetches the unique key for accessing this cache
public
getCacheKey() : string
Tags
Return values
string —Cache Key
getGroup()
Fetches the group from the cache
public
getGroup(string $sGroupName) : array<string|int, mixed>
Parameters
- $sGroupName : string
-
Group Name
Tags
Return values
array<string|int, mixed> —Group Value
getGroupParameter()
Fetches the value for the group parameter from the cache
public
getGroupParameter(string $sGroupName, string $sParameterName) : mixed
Parameters
- $sGroupName : string
-
Group Name
- $sParameterName : string
-
Parameter Name
Tags
Return values
mixed —The parameter value
getParameter()
Fetches the parameter from the cache
public
getParameter(string $sParameterName[, bool $bRecordContext = false ]) : mixed
Parameters
- $sParameterName : string
-
Parameter Name
- $bRecordContext : bool = false
-
If true, the parameter is returned from the current record type context
Tags
Return values
mixed —Parameter Value
removeGroup()
Removes the group from the cache
public
removeGroup(string $sGroupName) : mixed
Parameters
- $sGroupName : string
-
Group Name
Tags
Return values
mixed —removeGroupParameter()
Removes the group parameter from the cache
public
removeGroupParameter(string $sGroupName, string $sParameterName) : mixed
Parameters
- $sGroupName : string
-
Group Name
- $sParameterName : string
-
Parameter Name
Tags
Return values
mixed —removeParameter()
Removes the parameter from the cache
public
removeParameter(string $sParameterName) : mixed
Parameters
- $sParameterName : string
-
Parameter Name
Tags
Return values
mixed —saveInSession()
Saves cache into Session
public
final saveInSession() : mixed
Tags
Return values
mixed —setParameter()
Sets a parameter into the cache
public
setParameter(string $sParameterName, mixed $mParameterValue[, bool $bRecordContext = false ]) : mixed
Parameters
- $sParameterName : string
-
Parameter Name
- $mParameterValue : mixed
-
Parameter Value
- $bRecordContext : bool = false
-
If true, the parameter is saved in the current record type context
Tags
Return values
mixed —toArray()
Fetches the array representation of the cache
public
toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array representation of the cache