Overview

Packages

  • Kolab
    • Storage

Classes

  • Horde_Kolab_Storage_Base
  • Horde_Kolab_Storage_Cache
  • Horde_Kolab_Storage_Cache_Data
  • Horde_Kolab_Storage_Cache_List
  • Horde_Kolab_Storage_Cached
  • Horde_Kolab_Storage_Data_Base
  • Horde_Kolab_Storage_Data_Cached
  • Horde_Kolab_Storage_Data_Decorator_Log
  • Horde_Kolab_Storage_Data_Format_Mime
  • Horde_Kolab_Storage_Data_Modifiable
  • Horde_Kolab_Storage_Data_Old
  • Horde_Kolab_Storage_Data_Parser_Structure
  • Horde_Kolab_Storage_Data_Query_History_Base
  • Horde_Kolab_Storage_Data_Query_History_Cache
  • Horde_Kolab_Storage_Data_Query_Preferences_Base
  • Horde_Kolab_Storage_Data_Query_Preferences_Cache
  • Horde_Kolab_Storage_Decorator_Synchronization
  • Horde_Kolab_Storage_Driver_Base
  • Horde_Kolab_Storage_Driver_Cclient
  • Horde_Kolab_Storage_Driver_Decorator_Base
  • Horde_Kolab_Storage_Driver_Decorator_Log
  • Horde_Kolab_Storage_Driver_Decorator_Timer
  • Horde_Kolab_Storage_Driver_Imap
  • Horde_Kolab_Storage_Driver_Mock
  • Horde_Kolab_Storage_Driver_Mock_Data
  • Horde_Kolab_Storage_Driver_Pear
  • Horde_Kolab_Storage_Driver_Rcube
  • Horde_Kolab_Storage_Exception
  • Horde_Kolab_Storage_Exception_Pear
  • Horde_Kolab_Storage_Factory
  • Horde_Kolab_Storage_Folder_Base
  • Horde_Kolab_Storage_Folder_Decorator_Base
  • Horde_Kolab_Storage_Folder_Decorator_Trigger
  • Horde_Kolab_Storage_Folder_Namespace
  • Horde_Kolab_Storage_Folder_Namespace_Config
  • Horde_Kolab_Storage_Folder_Namespace_Element
  • Horde_Kolab_Storage_Folder_Namespace_Element_Other
  • Horde_Kolab_Storage_Folder_Namespace_Element_Personal
  • Horde_Kolab_Storage_Folder_Namespace_Element_Shared
  • Horde_Kolab_Storage_Folder_Namespace_Element_SharedWithPrefix
  • Horde_Kolab_Storage_Folder_Namespace_Fixed
  • Horde_Kolab_Storage_Folder_Namespace_Imap
  • Horde_Kolab_Storage_Folder_Stamp_Uids
  • Horde_Kolab_Storage_Folder_Type
  • Horde_Kolab_Storage_List_Base
  • Horde_Kolab_Storage_List_Decorator_Cache
  • Horde_Kolab_Storage_List_Decorator_Log
  • Horde_Kolab_Storage_List_Query_Acl_Base
  • Horde_Kolab_Storage_List_Query_Acl_Cache
  • Horde_Kolab_Storage_List_Query_ActiveSync_Base
  • Horde_Kolab_Storage_List_Query_ActiveSync_Cache
  • Horde_Kolab_Storage_List_Query_List_Base
  • Horde_Kolab_Storage_List_Query_List_Cache
  • Horde_Kolab_Storage_List_Query_Share_Base
  • Horde_Kolab_Storage_List_Query_Share_Cache
  • Horde_Kolab_Storage_QuerySet_Base
  • Horde_Kolab_Storage_QuerySet_Cached
  • Horde_Kolab_Storage_QuerySet_Uncached
  • Horde_Kolab_Storage_Synchronization
  • Horde_Kolab_Storage_Translation
  • Horde_Kolab_Storage_Uncached

Interfaces

  • Horde_Kolab_Storage
  • Horde_Kolab_Storage_Data
  • Horde_Kolab_Storage_Data_Format
  • Horde_Kolab_Storage_Data_Parser
  • Horde_Kolab_Storage_Data_Query
  • Horde_Kolab_Storage_Data_Query_History
  • Horde_Kolab_Storage_Data_Query_Preferences
  • Horde_Kolab_Storage_Driver
  • Horde_Kolab_Storage_Folder
  • Horde_Kolab_Storage_Folder_Stamp
  • Horde_Kolab_Storage_List
  • Horde_Kolab_Storage_List_Query
  • Horde_Kolab_Storage_List_Query_Acl
  • Horde_Kolab_Storage_List_Query_ActiveSync
  • Horde_Kolab_Storage_List_Query_List
  • Horde_Kolab_Storage_List_Query_Share
  • Horde_Kolab_Storage_Queriable
  • Horde_Kolab_Storage_Query
  • Horde_Kolab_Storage_QuerySet
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_Storage_Cache

The Kolab_Cache class provides a cache for Kolab groupware objects.

The Horde_Kolab_Storage_Cache singleton instance provides caching for all storage folders. So before operating on the cache data it is necessary to load the desired folder data. Before switching the folder the cache data should be saved.

This class does not offer a lot of safeties and is primarily intended to be used within the Horde_Kolab_Storage_Data class.

Copyright 2007-2012 Horde LLC (http://www.horde.org/)

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.php
Methods summary
public
# __construct( Horde_Cache $cache )

Constructor.

Constructor.

Parameters

$cache
The global cache for temporary data storage.
public Horde_Kolab_Storage_Cache_Data
# getDataCache( array $data_params )

Return a data cache.

Return a data cache.

Parameters

$data_params
<p>Return the data cache for a data set with these parameters.</p>

Returns

Horde_Kolab_Storage_Cache_Data
The data cache.
public string
# loadData( string $data_id )

Retrieve data set.

Retrieve data set.

Parameters

$data_id
ID of the data set.

Returns

string
The cached data set.
public null
# storeData( string $data_id, string $data )

Cache data set.

Cache data set.

Parameters

$data_id
ID of the data set.
$data
The data to be cached.

Returns

null
public resource
# loadAttachment( string $data_id, string $obid, string $attachment_id )

Retrieve an attachment.

Retrieve an attachment.

Parameters

$data_id
ID of the data set.
$obid
Object backend id.
$attachment_id
Attachment ID.

Returns

resource
A stream opened to the attachement data.
public null
# storeAttachment( string $data_id, string $obid, string $attachment_id, resource $data )

Store an attachment.

Store an attachment.

Parameters

$data_id
ID of the data set.
$obid
Object backend id.
$attachment_id
Attachment ID.
$data
A stream opened to the attachement data.

Returns

null
public null
# deleteAttachment( string $data_id, string $obid, string $attachment_id )

Delete a cached attachment.

Delete a cached attachment.

Parameters

$data_id
ID of the data set.
$obid
Object backend id.
$attachment_id
Attachment ID.

Returns

null
public Horde_Kolab_Storage_Cache_List
# getListCache( array $connection_params )

Return a list cache.

Return a list cache.

Parameters

$connection_params
<p>Return the list cache for a connection with these parameters.</p>

Returns

Horde_Kolab_Storage_Cache_List
The list cache.
public string
# loadList( string $list_id )

Retrieve list data.

Retrieve list data.

Parameters

$list_id
ID of the connection matching the list.

Returns

string
The data of the object.
public null
# storeList( string $list_id, string $data )

Cache list data.

Cache list data.

Parameters

$list_id
ID of the connection matching the list.
$data
The data to be cached.

Returns

null
API documentation generated by ApiGen