API Documentation
\

\Horde_Kolab_Storage_List_Cache

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.

Summary

Methods
Properties
Constants
__construct()
getListId()
save()
isInitialized()
getStamp()
getFolders()
hasFolderTypes()
getFolderTypes()
hasNamespace()
getNamespace()
setNamespace()
issetSupport()
hasSupport()
setSupport()
hasQuery()
getQuery()
setQuery()
hasLongTerm()
getLongTerm()
setLongTerm()
store()
No public properties found
FOLDERS
TYPES
NAME_SPACE
SUPPORT
QUERIES
LONG_TERM
SYNC
VERSION
ID
FORMAT_VERSION
No protected methods found
No protected properties found
N/A
_setListId()
_load()
$_cache
$_parameters
$_list_id
$_data
N/A

Constants

FOLDERS

FOLDERS

Key for the folder list.

TYPES

TYPES

Key for the type list.

NAME_SPACE

NAME_SPACE

Key for the namespace data.

SUPPORT

SUPPORT

Key for the backend capabilities.

QUERIES

QUERIES

Holds query results.

LONG_TERM

LONG_TERM

Holds long term cache data.

SYNC

SYNC

Key for the last time the list was synchronized.

VERSION

VERSION

Key for the cache format version.

ID

ID

Key for the connection ID associated with this list cache.

FORMAT_VERSION

FORMAT_VERSION

Holds the version number of the cache format.

Properties

$_parameters

$_parameters : array

List parameters that will be recorded in the cache.

Type

array

$_list_id

$_list_id : string

List ID.

Type

string

$_data

$_data : array

The list data.

Type

array

Methods

__construct()

__construct(\Horde_Kolab_Storage_Cache  $cache, array  $parameters = array())

Constructor.

Parameters

\Horde_Kolab_Storage_Cache $cache

The core cache driver.
array $parameters

Connection parameters that are only recorded and have no further impact.

getListId()

getListId() : string

Return the ID for the list cache.

Returns

string —

The unique ID for the list used when caching it.

save()

save() : NULL

Cache the list data.

Returns

NULL

isInitialized()

isInitialized() : boolean

Check if the cache has been initialized.

Returns

boolean —

True if cache data is available.

getStamp()

getStamp() : string

Returns the last sync stamp.

Returns

string —

The last sync stamp.

getFolders()

getFolders() : array

Returns the list of folders from the cache.

Returns

array —

The list of folders, represented as a list of strings.

hasFolderTypes()

hasFolderTypes() : boolean

Returns if the folder type annotation is stored in the cache.

Returns

boolean —

True if the type annotation is available.

getFolderTypes()

getFolderTypes() : array

Returns the folder type annotation from the cache.

Returns

array —

The list folder types with the folder names as key and the folder type as values.

hasNamespace()

hasNamespace() : boolean

Returns if the namespace information is available.

Returns

boolean —

True if the information exists in the cache.

getNamespace()

getNamespace() : mixed

Return namespace information.

Returns

mixed —

The namespace data.

setNamespace()

setNamespace(mixed  $data) : NULL

Set namespace information.

Parameters

mixed $data

The namespace data.

Returns

NULL

issetSupport()

issetSupport(  $capability) : boolean

Has the capability support already been cached?

Parameters

$capability

Returns

boolean —

True if the value is already in the cache.

hasSupport()

hasSupport(string  $capability) : boolean

Has the list support for the requested capability?

Parameters

string $capability

The name of the requested capability.

Returns

boolean —

True if the backend supports the requested capability.

setSupport()

setSupport(string  $capability, boolean  $flag) : NULL

Set if the list supports the given capability.

Parameters

string $capability

The name of the requested capability.
boolean $flag

True if the capability is supported.

Returns

NULL

hasQuery()

hasQuery(string  $key) : boolean

Is the specified query data available in the cache?

Parameters

string $key

The query key.

Returns

boolean —

True in case cached data is available.

getQuery()

getQuery(string  $key) : mixed

Return query information.

Parameters

string $key

The query key.

Returns

mixed —

The query data.

setQuery()

setQuery(string  $key, mixed  $data) : NULL

Set query information.

Parameters

string $key

The query key.
mixed $data

The query data.

Returns

NULL

hasLongTerm()

hasLongTerm(string  $key) : boolean

Is the specified long term data available in the cache?

Parameters

string $key

The long term key.

Returns

boolean —

True in case cached data is available.

getLongTerm()

getLongTerm(string  $key) : mixed

Return long term information.

Parameters

string $key

The long term key.

Returns

mixed —

The long term data.

setLongTerm()

setLongTerm(string  $key, mixed  $data) : NULL

Set long term information.

Parameters

string $key

The long term key.
mixed $data

The long term data.

Returns

NULL

store()

store(array  $folders = null, array  $types = null) : NULL

Store the folder list and folder type annotations in the cache.

Parameters

array $folders
array $types

Returns

NULL

_setListId()

_setListId()

Compose the list key.

_load()

_load() : mixed

Retrieve the cached list data.

Returns

mixed —

The data of the object.