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_Data

A cache backend for Kolab storage data handlers.

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: Thomas Jarosch thomas.jarosch@intra2net.com
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/Cache/Data.php
Methods summary
public
# __construct( Horde_Kolab_Storage_Cache $cache, array $parameters = null )

Constructor.

Constructor.

Parameters

$cache
The core cache driver.
$parameters
<p>Data set parameters that are only recorded and have no further impact.</p>
public null
# setDataId( string $data_id )

The ID for the data cache.

The ID for the data cache.

Parameters

$data_id
The unique ID for the data used when caching it.

Returns

null
public string
# getDataId( )

Return the ID for the data cache.

Return the ID for the data cache.

Returns

string
The unique ID for the data used when caching it.
public null
# save( )

Cache the data.

Cache the 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 array
# getObjects( )

Retrieve the object list from the cache.

Retrieve the object list from the cache.

Returns

array
The list of objects.
public array
# getObjectByBackendId( string $obid )

Retrieve the specified object from the cache.

Retrieve the specified object from the cache.

Parameters

$obid
The object ID to fetch.

Returns

array
The list of objects.
public array
# getObjectToBackend( )

Return the object ID to backend ID mapping.

Return the object ID to backend ID mapping.

Returns

array
The mapping.
public array
# getBackendToObject( )

Return the backend ID to object ID mapping.

Return the backend ID to object ID mapping.

Returns

array
The mapping.
public Horde_Kolab_Storage_Folder_Stamp
# getStamp( )

Retrieve the last stamp.

Retrieve the last stamp.

Returns

Horde_Kolab_Storage_Folder_Stamp
The last recorded stamp.
public string
# getVersion( )

Retrieve the data version.

Retrieve the data version.

Returns

string
The version of the stored data.
public array
# getDuplicates( )

Retrieve the list of object duplicates.

Retrieve the list of object duplicates.

Returns

array
The list of duplicates.

Since

Horde_Kolab_Storage 1.1.0
public array
# getErrors( )

Retrieve the list of object errors.

Retrieve the list of object errors.

Returns

array
The list of errors.

Since

Horde_Kolab_Storage 1.1.0
public resource
# getAttachment( string $obid, string $attachment_id )

Retrieve an attachment.

Retrieve an attachment.

Parameters

$obid
Object backend id.
$attachment_id
Attachment ID.

Returns

resource
A stream opened to the attachement data.
public array
# getAttachmentByName( string $obid, string $name )

Retrieve an attachment by name.

Retrieve an attachment by name.

Parameters

$obid
Object backend id.
$name
$attachment_id Attachment ID.

Returns

array
An array of attachment resources.
public array
# getAttachmentByType( string $obid, string $type )

Retrieve an attachment by name.

Retrieve an attachment by name.

Parameters

$obid
Object backend id.
$type
$attachment_id Attachment ID.

Returns

array
An array of attachment resources.
public integer
# getLastSync( )

Return the timestamp of the last synchronization.

Return the timestamp of the last synchronization.

Returns

integer
Timestamp of the last sync.

Since

Horde_Kolab_Storage 1.1.0
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.

Since

Horde_Kolab_Storage 1.1.0
public mixed
# getQuery( string $key )

Return query information.

Return query information.

Parameters

$key
The query key.

Returns

mixed
The query data.

Since

Horde_Kolab_Storage 1.1.0
public null
# setQuery( string $key, mixed $data )

Set query information.

Set query information.

Parameters

$key
The query key.
$data
The query data.

Returns

null

Since

Horde_Kolab_Storage 1.1.0
public array
# backendMap( array $backend_ids )

Map backend IDs to object ids.

Map backend IDs to object ids.

Parameters

$backend_ids
The list of backend IDs

Returns

array

A list that associates object IDs (values) to backend IDs (keys).

Since

Horde_Kolab_Storage 1.1.0
public null
# store( array $objects, Horde_Kolab_Storage_Folder_Stamp $stamp, string $version, array $delete = array() )

Store the objects list in the cache.

Store the objects list in the cache.

Parameters

$objects
$object The object data to store.
$stamp
The current stamp.
$version
<p>The format version of the provided data.</p>
$delete
Backend IDs that were removed.

Returns

null
public null
# reset( )

Initialize the cache structure.

Initialize the cache structure.

Returns

null
Constants summary
string B2O

Key for the backend ID to object ID mapping.

Key for the backend ID to object ID mapping.
# 'M'
string O2B

Key for the object ID to backend ID mapping.

Key for the object ID to backend ID mapping.
# 'B'
string OBJECTS

Key for the objects.

Key for the objects.
# 'O'
string DUPLICATES

Key for recording duplicate objects.

Key for recording duplicate objects.
# 'U'
string ERRORS

Key for recording error objects.

Key for recording error objects.
# 'E'
string STAMP

Key for the stamp.

Key for the stamp.
# 'P'
string DATA_VERSION

Key for the data format version.

Key for the data format version.
# 'D'
string SYNC

Key for the last time the data was synchronized.

Key for the last time the data was synchronized.
# 'S'
string VERSION

Key for the cache format version.

Key for the cache format version.
# 'V'
string ID

Key for the data set parameters associated with this cache.

Key for the data set parameters associated with this cache.
# 'I'
string FORMAT_VERSION

Holds the version number of the cache format.

Holds the version number of the cache format.
# '1'
string QUERIES

Holds query results.

Holds query results.
# 'Q'
API documentation generated by ApiGen