Class Horde_Kolab_Storage_Cache_List

A cache backend for Kolab storage list handlers.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Kolab\Storage
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/Cache/List.php

Methods summary
`public`	# `__construct( Horde_Kolab_Storage_Cache $cache, array $parameters = null )` Constructor. Constructor. Parameters `$cache` The core cache driver. `$parameters` <p>Connection parameters that are only recorded and have no further impact.</p>
`public null`	# `setListId( string $list_id )` The ID for the list cache. The ID for the list cache. Parameters `$list_id` The unique ID for the list used when caching it. Returns `null`
`public string`	# `getListId( )` Return the ID for the list cache. Return the ID for the list cache. Returns `string` The unique ID for the list used when caching it.
`public null`	# `save( )` Cache the list data. Cache the list data. Returns `null`
`public boolean`	# `isInitialized( )` Check if the cache has been initialized. Check if the cache has been initialized. Returns `boolean` True if cache data is available.
`public string`	# `getStamp( )` Returns the last sync stamp. Returns the last sync stamp. Returns `string` The last sync stamp.
`public array`	# `getFolders( )` Returns the list of folders from the cache. Returns the list of folders from the cache. Returns `array` The list of folders, represented as a list of strings.
`public boolean`	# `hasFolderTypes( )` Returns if the folder type annotation is stored in the cache. Returns if the folder type annotation is stored in the cache. Returns `boolean` True if the type annotation is available. Since Horde_Kolab_Storage 1.1.0
`public array`	# `getFolderTypes( )` Returns the folder type annotation from the cache. 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.
`public boolean`	# `hasNamespace( )` Returns if the namespace information is available. Returns if the namespace information is available. Returns `boolean` True if the information exists in the cache.
`public mixed`	# `getNamespace( )` Return namespace information. Return namespace information. Returns `mixed` The namespace data.
`public null`	# `setNamespace( mixed $data )` Set namespace information. Set namespace information. Parameters `$data` The namespace data. Returns `null`
`public boolean`	# `issetSupport( mixed $capability )` Has the capability support already been cached? Has the capability support already been cached? Returns `boolean` True if the value is already in the cache.
`public boolean`	# `hasSupport( string $capability )` Has the list support for the requested capability? Has the list support for the requested capability? Parameters `$capability` The name of the requested capability. Returns `boolean` True if the backend supports the requested capability.
`public null`	# `setSupport( string $capability, boolean $flag )` Set if the list supports the given capability. Set if the list supports the given capability. Parameters `$capability` The name of the requested capability. `$flag` True if the capability is supported. Returns `null`
`public boolean`	# `hasQuery( string $key )` Is the specified query data available in the cache? Is the specified query data available in the cache? Parameters `$key` The query key. Returns `boolean` True in case cached data is available.
`public mixed`	# `getQuery( string $key )` Return query information. Return query information. Parameters `$key` The query key. Returns `mixed` The query data.
`public null`	# `setQuery( string $key, mixed $data )` Set query information. Set query information. Parameters `$key` The query key. `$data` The query data. Returns `null`
`public boolean`	# `hasLongTerm( string $key )` Is the specified long term data available in the cache? Is the specified long term data available in the cache? Parameters `$key` The long term key. Returns `boolean` True in case cached data is available.
`public mixed`	# `getLongTerm( string $key )` Return long term information. Return long term information. Parameters `$key` The long term key. Returns `mixed` The long term data.
`public null`	# `setLongTerm( string $key, mixed $data )` Set long term information. Set long term information. Parameters `$key` The long term key. `$data` The long term data. Returns `null`
`public null`	# `store( array $folders = null, array $types = null )` Store the folder list and folder type annotations in the cache. Store the folder list and folder type annotations in the cache. Returns `null`

Constants summary
`string`	`FOLDERS` Key for the folder list. Key for the folder list.	# `'F'`
`string`	`TYPES` Key for the type list. Key for the type list.	# `'T'`
`string`	`NAME_SPACE` Key for the namespace data. Key for the namespace data.	# `'N'`
`string`	`SUPPORT` Key for the backend capabilities. Key for the backend capabilities.	# `'C'`
`string`	`QUERIES` Holds query results. Holds query results.	# `'Q'`
`string`	`LONG_TERM` Holds long term cache data. Holds long term cache data.	# `'L'`
`string`	`SYNC` Key for the last time the list was synchronized. Key for the last time the list was synchronized.	# `'S'`
`string`	`VERSION` Key for the cache format version. Key for the cache format version.	# `'V'`
`string`	`ID` Key for the connection ID associated with this list cache. Key for the connection ID associated with this list cache.	# `'I'`
`string`	`FORMAT_VERSION` Holds the version number of the cache format. Holds the version number of the cache format.	# `'1'`

Packages

Classes

Interfaces

Class Horde_Kolab_Storage_Cache_List

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Since

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns