Horde_Kolab_Storage_List_Cache
in package
A cache backend for Kolab storage list handlers.
Copyright 2010-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- FOLDERS = 'F'
- Key for the folder list.
- FORMAT_VERSION = '1'
- Holds the version number of the cache format.
- ID = 'I'
- Key for the connection ID associated with this list cache.
- LONG_TERM = 'L'
- Holds long term cache data.
- NAME_SPACE = 'N'
- Key for the namespace data.
- QUERIES = 'Q'
- Holds query results.
- SUPPORT = 'C'
- Key for the backend capabilities.
- SYNC = 'S'
- Key for the last time the list was synchronized.
- TYPES = 'T'
- Key for the type list.
- VERSION = 'V'
- Key for the cache format version.
- $_cache : Horde_Kolab_Storage_Cache
- The core cache driver.
- $_data : array<string|int, mixed>
- The list data.
- $_list_id : string
- List ID.
- $_parameters : array<string|int, mixed>
- List parameters that will be recorded in the cache.
- __construct() : mixed
- Constructor.
- getFolders() : array<string|int, mixed>
- Returns the list of folders from the cache.
- getFolderTypes() : array<string|int, mixed>
- Returns the folder type annotation from the cache.
- getListId() : string
- Return the ID for the list cache.
- getLongTerm() : mixed
- Return long term information.
- getNamespace() : mixed
- Return namespace information.
- getQuery() : mixed
- Return query information.
- getStamp() : string
- Returns the last sync stamp.
- hasFolderTypes() : bool
- Returns if the folder type annotation is stored in the cache.
- hasLongTerm() : bool
- Is the specified long term data available in the cache?
- hasNamespace() : bool
- Returns if the namespace information is available.
- hasQuery() : bool
- Is the specified query data available in the cache?
- hasSupport() : bool
- Has the list support for the requested capability?
- isInitialized() : bool
- Check if the cache has been initialized.
- issetSupport() : bool
- Has the capability support already been cached?
- save() : null
- Cache the list data.
- setLongTerm() : null
- Set long term information.
- setNamespace() : null
- Set namespace information.
- setQuery() : null
- Set query information.
- setSupport() : null
- Set if the list supports the given capability.
- store() : null
- Store the folder list and folder type annotations in the cache.
- _load() : mixed
- Retrieve the cached list data.
- _setListId() : mixed
- Compose the list key.
Constants
FOLDERS
Key for the folder list.
public
mixed
FOLDERS
= 'F'
FORMAT_VERSION
Holds the version number of the cache format.
public
mixed
FORMAT_VERSION
= '1'
ID
Key for the connection ID associated with this list cache.
public
mixed
ID
= 'I'
LONG_TERM
Holds long term cache data.
public
mixed
LONG_TERM
= 'L'
NAME_SPACE
Key for the namespace data.
public
mixed
NAME_SPACE
= 'N'
QUERIES
Holds query results.
public
mixed
QUERIES
= 'Q'
SUPPORT
Key for the backend capabilities.
public
mixed
SUPPORT
= 'C'
SYNC
Key for the last time the list was synchronized.
public
mixed
SYNC
= 'S'
TYPES
Key for the type list.
public
mixed
TYPES
= 'T'
VERSION
Key for the cache format version.
public
mixed
VERSION
= 'V'
Properties
$_cache
The core cache driver.
private
Horde_Kolab_Storage_Cache
$_cache
$_data
The list data.
private
array<string|int, mixed>
$_data
= \false
$_list_id
List ID.
private
string
$_list_id
$_parameters
List parameters that will be recorded in the cache.
private
array<string|int, mixed>
$_parameters
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Cache $cache[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
- $cache : Horde_Kolab_Storage_Cache
-
The core cache driver.
- $parameters : array<string|int, mixed> = array()
-
Connection parameters that are only recorded and have no further impact.
Return values
mixed —getFolders()
Returns the list of folders from the cache.
public
getFolders() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of folders, represented as a list of strings.
getFolderTypes()
Returns the folder type annotation from the cache.
public
getFolderTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list folder types with the folder names as key and the folder type as values.
getListId()
Return the ID for the list cache.
public
getListId() : string
Return values
string —The unique ID for the list used when caching it.
getLongTerm()
Return long term information.
public
getLongTerm(string $key) : mixed
Parameters
- $key : string
-
The long term key.
Return values
mixed —The long term data.
getNamespace()
Return namespace information.
public
getNamespace() : mixed
Return values
mixed —The namespace data.
getQuery()
Return query information.
public
getQuery(string $key) : mixed
Parameters
- $key : string
-
The query key.
Return values
mixed —The query data.
getStamp()
Returns the last sync stamp.
public
getStamp() : string
Return values
string —The last sync stamp.
hasFolderTypes()
Returns if the folder type annotation is stored in the cache.
public
hasFolderTypes() : bool
Return values
bool —True if the type annotation is available.
hasLongTerm()
Is the specified long term data available in the cache?
public
hasLongTerm(string $key) : bool
Parameters
- $key : string
-
The long term key.
Return values
bool —True in case cached data is available.
hasNamespace()
Returns if the namespace information is available.
public
hasNamespace() : bool
Return values
bool —True if the information exists in the cache.
hasQuery()
Is the specified query data available in the cache?
public
hasQuery(string $key) : bool
Parameters
- $key : string
-
The query key.
Return values
bool —True in case cached data is available.
hasSupport()
Has the list support for the requested capability?
public
hasSupport(string $capability) : bool
Parameters
- $capability : string
-
The name of the requested capability.
Return values
bool —True if the backend supports the requested capability.
isInitialized()
Check if the cache has been initialized.
public
isInitialized() : bool
Return values
bool —True if cache data is available.
issetSupport()
Has the capability support already been cached?
public
issetSupport(mixed $capability) : bool
Parameters
- $capability : mixed
Return values
bool —True if the value is already in the cache.
save()
Cache the list data.
public
save() : null
Return values
null —setLongTerm()
Set long term information.
public
setLongTerm(string $key, mixed $data) : null
Parameters
- $key : string
-
The long term key.
- $data : mixed
-
The long term data.
Return values
null —setNamespace()
Set namespace information.
public
setNamespace(mixed $data) : null
Parameters
- $data : mixed
-
The namespace data.
Return values
null —setQuery()
Set query information.
public
setQuery(string $key, mixed $data) : null
Parameters
- $key : string
-
The query key.
- $data : mixed
-
The query data.
Return values
null —setSupport()
Set if the list supports the given capability.
public
setSupport(string $capability, bool $flag) : null
Parameters
- $capability : string
-
The name of the requested capability.
- $flag : bool
-
True if the capability is supported.
Return values
null —store()
Store the folder list and folder type annotations in the cache.
public
store([array<string|int, mixed> $folders = null ][, array<string|int, mixed> $types = null ]) : null
Parameters
- $folders : array<string|int, mixed> = null
- $types : array<string|int, mixed> = null
Return values
null —_load()
Retrieve the cached list data.
private
_load() : mixed
Return values
mixed —The data of the object.
_setListId()
Compose the list key.
private
_setListId() : mixed