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_Data_Old

The Kolab_Data class represents a data type in a Kolab storage folder on the Kolab server.

Copyright 2009-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: Stuart Binge omicron@mighty.co.za
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/Data/Old.php
Methods summary
public
# __construct( string $folder, string $type, Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Factory $factory, string $object_type = null, integer $data_version = 1 )

Creates a Kolab Folder Data representation.

Creates a Kolab Folder Data representation.

Parameters

$folder
Name/ID of the folder.
$type
Type of the folder.
$driver
The primary connection driver.
$factory
The factory.
$object_type
Type of the objects we want to read.
$data_version
Format version of the object data.
public boolean|PEAR_Error
# delete( string $object_uid )

Delete the specified message from this folder.

Delete the specified message from this folder.

Parameters

$object_uid
Id of the message to be deleted.

Returns

boolean|PEAR_Error

True is successful, false if the message does not exist.

public boolean|PEAR_Error
# deleteAll( )

Delete all messages from the current folder.

Delete all messages from the current folder.

Returns

boolean|PEAR_Error
True if successful.
public boolean|PEAR_Error
# move( string $object_uid, string $new_share )

Move the specified message from the current folder into a new folder.

Move the specified message from the current folder into a new folder.

Parameters

$object_uid
ID of the message to be deleted.
$new_share
ID of the target share.

Returns

boolean|PEAR_Error

True is successful, false if the object does not exist.

public boolean
# save( array $object, string $old_object_id = null )

Save an object.

Save an object.

Parameters

$object
The array that holds the data object.
$old_object_id
The id of the object if it existed before.

Returns

boolean
True on success.

Throws

Horde_Kolab_Storage_Exception

In case the given old object id is invalid or an error occured while saving the data.

public null
# synchronize( string $history_ignore = null )

Synchronize the data cache for the current folder.

Synchronize the data cache for the current folder.

Parameters

$history_ignore
<p>Object uid that should not be updated in the History</p>

Returns

null
public boolean
# storageIdExists( integer $uid )

Test if the storage ID exists.

Test if the storage ID exists.

Parameters

$uid
The storage ID.

Returns

boolean
True if the ID exists.
public string
# generateUID( )

Generate a unique object id.

Generate a unique object id.

Returns

string
The unique id.
public string|PEAR_Error
# getAttachment( string $attachment_id )

Return the specified attachment.

Return the specified attachment.

Parameters

$attachment_id
The attachment id.

Returns

string|PEAR_Error
The attachment data as a string.
public array
# getObjectArray( )

Retrieve all objects in the current folder as an array.

Retrieve all objects in the current folder as an array.

Returns

array
The object data array.
API documentation generated by ApiGen