PHP Класс Horde_Kolab_Storage_List_Cache, horde

См. ссылку: http://pear.horde.org/index.php?package=Kolab_Storage

Автор: Gunnar Wrobel ([email protected])

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__construct ( Horde_Kolab_Storage_Cache $cache, array $parameters = [] )	Constructor.
getFolderTypes ( ) : array	Returns the folder type annotation from the cache.
getFolders ( ) : array	Returns the list of folders from the cache.
getListId ( ) : string	Return the ID for the list cache.
getLongTerm ( string $key ) : mixed	Return long term information.
getNamespace ( ) : mixed	Return namespace information.
getQuery ( string $key ) : mixed	Return query information.
getStamp ( ) : string	Returns the last sync stamp.
hasFolderTypes ( ) : boolean	Returns if the folder type annotation is stored in the cache.
hasLongTerm ( string $key ) : boolean	Is the specified long term data available in the cache?
hasNamespace ( ) : boolean	Returns if the namespace information is available.
hasQuery ( string $key ) : boolean	Is the specified query data available in the cache?
hasSupport ( string $capability ) : boolean	Has the list support for the requested capability?
isInitialized ( ) : boolean	Check if the cache has been initialized.
issetSupport ( $capability ) : boolean	Has the capability support already been cached?
save ( ) : null	Cache the list data.
setLongTerm ( string $key, mixed $data ) : null	Set long term information.
setNamespace ( mixed $data ) : null	Set namespace information.
setQuery ( string $key, mixed $data ) : null	Set query information.
setSupport ( string $capability, boolean $flag ) : null	Set if the list supports the given capability.
store ( array $folders = null, array $types = null ) : null	Store the folder list and folder type annotations in the cache.

Приватные методы

Метод	Описание
_load ( ) : mixed	Retrieve the cached list data.
_setListId ( )	Compose the list key.

Описание методов

__construct() публичный метод

Constructor.

public __construct ( Horde_Kolab_Storage_Cache $cache, array $parameters = [] )
$cache	Horde_Kolab_Storage_Cache	The core cache driver.
$parameters	array	Connection parameters that are only recorded and have no further impact.

getFolderTypes() публичный метод

Returns the folder type annotation from the cache.

public getFolderTypes ( ) : array
Результат	array	The list folder types with the folder names as key and the folder type as values.

getFolders() публичный метод

Returns the list of folders from the cache.

public getFolders ( ) : array
Результат	array	The list of folders, represented as a list of strings.

getListId() публичный метод

Return the ID for the list cache.

public getListId ( ) : string
Результат	string	The unique ID for the list used when caching it.

getLongTerm() публичный метод

Return long term information.

public getLongTerm ( string $key ) : mixed
$key	string	The long term key.
Результат	mixed	The long term data.

getNamespace() публичный метод

Return namespace information.

public getNamespace ( ) : mixed
Результат	mixed	The namespace data.

getQuery() публичный метод

Return query information.

public getQuery ( string $key ) : mixed
$key	string	The query key.
Результат	mixed	The query data.

getStamp() публичный метод

Returns the last sync stamp.

public getStamp ( ) : string
Результат	string	The last sync stamp.

hasFolderTypes() публичный метод

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

public hasFolderTypes ( ) : boolean
Результат	boolean	True if the type annotation is available.

hasLongTerm() публичный метод

Is the specified long term data available in the cache?

public hasLongTerm ( string $key ) : boolean
$key	string	The long term key.
Результат	boolean	True in case cached data is available.

hasNamespace() публичный метод

Returns if the namespace information is available.

public hasNamespace ( ) : boolean
Результат	boolean	True if the information exists in the cache.

hasQuery() публичный метод

Is the specified query data available in the cache?

public hasQuery ( string $key ) : boolean
$key	string	The query key.
Результат	boolean	True in case cached data is available.

hasSupport() публичный метод

Has the list support for the requested capability?

public hasSupport ( string $capability ) : boolean
$capability	string	The name of the requested capability.
Результат	boolean	True if the backend supports the requested capability.

isInitialized() публичный метод

Check if the cache has been initialized.

public isInitialized ( ) : boolean
Результат	boolean	True if cache data is available.

issetSupport() публичный метод

Has the capability support already been cached?

public issetSupport ( $capability ) : boolean
Результат	boolean	True if the value is already in the cache.

save() публичный метод

Cache the list data.

public save ( ) : null
Результат	null

setLongTerm() публичный метод

Set long term information.

public setLongTerm ( string $key, mixed $data ) : null
$key	string	The long term key.
$data	mixed	The long term data.
Результат	null

setNamespace() публичный метод

Set namespace information.

public setNamespace ( mixed $data ) : null
$data	mixed	The namespace data.
Результат	null

setQuery() публичный метод

Set query information.

public setQuery ( string $key, mixed $data ) : null
$key	string	The query key.
$data	mixed	The query data.
Результат	null

setSupport() публичный метод

Set if the list supports the given capability.

public setSupport ( string $capability, boolean $flag ) : null
$capability	string	The name of the requested capability.
$flag	boolean	True if the capability is supported.
Результат	null

store() публичный метод

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

public store ( array $folders = null, array $types = null ) : null
$folders	array
$types	array
Результат	null