Class Kolab_Storage_Deprecated

Description

The Kolab_Storage class provides the means to access the Kolab server storage for groupware objects.

This contains the functionality that has been deprecated but not yet removed. This will happen once we move to Horde4 and can break backward compatibility. The intended way of using the Kolab storage handling is to use the main Kolab_Storage class only.

$Horde: framework/Kolab_Storage/lib/Horde/Kolab/Deprecated.php,v 1.1.2.4 2009/01/06 15:23:17 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Storage/lib/Horde/Kolab/Deprecated.php (line 32)

Kolab_Storage
   |
   --Kolab_Storage_Deprecated
Variable Summary
Method Summary
 void close ()
 mixed delete (string $object_uid)
 void deleteAll ()
 void exists ()
 mixed findObject (string $uid)
 mixed findObjects (string $criteria)
 string generateUID ()
 mixed getMailboxType (object $mailbox)
 string getMimeType ()
 mixed getObject (string $object_id)
 array getObjectArray ()
 array getObjectIds ()
 array getObjects ()
 string kolabNewlines (string $text)
 array listFolders ()
 mixed listObjects ()
 mixed listObjectsInFolder (string $folder)
 mixed loadObject (string $uid, [boolean $is_msgno = false])
 mixed move (string $object_uid, string $new_share)
 mixed moveObject (string $uid, boolean $new_share)
 mixed newObject (string $uid)
 boolean objectUidExists (string $uid)
 mixed open (string $share,  $app_consts, [int $loader_version = 0])
 string parseFolder (string $share)
 mixed removeAllObjects ()
 mixed removeObjects (string $objects, [boolean $is_msgno = false])
 mixed save (array $object, [string $old_object_id = null])
 mixed saveObject ( $xml,  $uid)
 void setObjectType ( $type)
Variables
string $_app_consts (line 59)

A copy of the app_consts for the current app

  • deprecated:
Kolab_Data $_data (line 50)

The the folder data we currently access.

  • deprecated:
Kolab_Folder $_folder (line 41)

The the folder we currently access.

  • deprecated:
MIME_Header $_headers (line 124)

Message headers

  • deprecated:
resource $_imap (line 87)

The IMAP connection

  • deprecated:
int $_loader_version (line 68)

Version of the data format to load

  • deprecated:
MIME_Message $_message (line 135)

The MIME_Message object that contains the currently loaded message. This is used when updating an object, in order to preserve everything else within the message that we don't know how to handle.

  • deprecated:
int $_mime_id (line 115)

The id of the part with the Kolab attachment.

  • deprecated:
string $_mime_type (line 106)

The full mime type string of the current Kolab object format we're dealing with.

  • deprecated:
integer $_msg_no (line 144)

The IMAP message number of $this->_message.

  • deprecated:
string $_object_type (line 96)

Folder object type

  • deprecated:
string $_share (line 78)

The (encoded) name of the IMAP folder that corresponds to the current share.

  • deprecated:
Methods
close (line 265)

Close the current folder.

  • deprecated:
void close ()
delete (line 299)

Delete the specified message from the current folder

  • return: True is successful, false if the message does not exist, a PEAR error otherwise.
  • deprecated:
mixed delete (string $object_uid)
  • string $object_uid: Id of the message to be deleted.
deleteAll (line 284)
  • deprecated:
void deleteAll ()
exists (line 274)
  • deprecated:
void exists ()
findObject (line 477)

Find the object with the given UID in the current share.

  • return: false if there is no such object
  • deprecated:
mixed findObject (string $uid)
  • string $uid: The UID of the object.
findObjects (line 856)

Find the object using the given criteria in the current share.

  • return: false if no object can be found
  • deprecated:
mixed findObjects (string $criteria)
  • string $criteria: The search criteria.
generateUID (line 343)

Generate a unique object id

  • return: The unique id
  • deprecated:
string generateUID ()
getMailboxType (line 827)

Returns the groupware type of the given IMAP folder.

  • return: A string indicating the groupware type of $mailbox or boolean "false" on error.
  • deprecated:
mixed getMailboxType (object $mailbox)
  • object $mailbox: The mailbox of interest.
getMimeType (line 873)

Return the MIME type of the message we are currently dealing with.

  • return: The MIME type of the message we are currently dealing with.
  • deprecated:
string getMimeType ()
getObject (line 372)

Return the specified object

  • return: The object data as array or a PEAR error if the object is missing from the cache.
  • deprecated:
mixed getObject (string $object_id)
  • string $object_id: The object id
getObjectArray (line 408)

Retrieve all objects in the current folder as an array

  • return: The object data array
  • deprecated:
array getObjectArray ()
getObjectIds (line 384)

Retrieve all object ids in the current folder

  • return: The object ids
  • deprecated:
array getObjectIds ()
getObjects (line 396)

Retrieve all objects in the current folder

  • return: All object data arrays
  • deprecated:
array getObjects ()
kolabNewlines (line 842)

Converts all newlines (in DOS, MAC & UNIX format) in the specified text to Kolab (Cyrus) format.

  • return: with all newlines replaced by KOLAB_NEWLINE.
  • deprecated:
string kolabNewlines (string $text)
  • string $text: The text to convert.
listFolders (line 246)

Returns a list of all IMAP folders (including their groupware type) that the current user has acccess to.

  • return: An array of array($foldername, $foldertype) items (empty on error).
  • deprecated:
array listFolders ()
listObjects (line 421)

List the objects in the current share.

  • return: false if there are no objects, a list of message ids or a PEAR error.
  • deprecated:
mixed listObjects ()
listObjectsInFolder (line 450)

List the objects in the specified folder.

  • return: false if there are no objects, a list of message ids otherwise.
  • deprecated:
mixed listObjectsInFolder (string $folder)
  • string $folder: The folder to search.
loadObject (line 518)

Load the object with the given UID into $this->_xml

  • return: false if there is no such object, a PEAR error if the object could not be loaded. Otherwise the xml document will be returned
  • deprecated:
mixed loadObject (string $uid, [boolean $is_msgno = false])
  • string $uid: The UID of the object.
  • boolean $is_msgno: Indicate if $uid holds an IMAP message number
move (line 316)

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

  • return: True is successful, false if the object does not exist, a PEAR error otherwise.
  • deprecated:
mixed move (string $object_uid, string $new_share)
  • string $object_uid: ID of the message to be deleted.
  • string $new_share: ID of the target share.
moveObject (line 693)

Move the object with the given UID from the current share into the specified new share.

  • return: false if there is no current share, a PEAR error if the object could not be moved. True otherwise.
  • deprecated:
mixed moveObject (string $uid, boolean $new_share)
  • string $uid: The UID of the object.
  • boolean $new_share: The share the object should be moved to.
newObject (line 579)

Create the object with UID in the current share

  • return: false if there is no open share, a PEAR error if the object could not be created. Otherwise the xml document will be returned
  • deprecated:
mixed newObject (string $uid)
  • string $uid: The UID of the object.
objectUidExists (line 357)

Check if the given id exists

  • return: True if the id was found, false otherwise
  • deprecated:
boolean objectUidExists (string $uid)
  • string $uid: The object id
open (line 158)

Open the specified share.

  • return: True on success, a PEAR error otherwise
  • deprecated:
mixed open (string $share,  $app_consts, [int $loader_version = 0])
  • string $share: The id of the share that should be opened.
  • int $loader_version: The version of the format loader
  • $app_consts
parseFolder (line 209)

Handles the horde syntax for default shares

  • return: The corrected IMAP folder name.
  • deprecated:
string parseFolder (string $share)
  • string $share: The share name that should be parsed
removeAllObjects (line 793)

Remove all objects from the current share.

  • return: false if there is no IMAP connection, a PEAR error if the objects could not be removed. True if the call succeeded.
  • deprecated:
mixed removeAllObjects ()
removeObjects (line 740)

Remove the specified objects from the current share.

  • return: false if there is no IMAP connection, a PEAR error if the objects could not be removed. True if the call succeeded.
  • deprecated:
mixed removeObjects (string $objects, [boolean $is_msgno = false])
  • string $objects: The UIDs (or maessage numbers) of the objects to be deleted.
  • boolean $is_msgno: Indicate if $objects holds IMAP message numbers
save (line 331)

Save an object.

  • return: True on success, a PEAR error otherwise
  • deprecated:
mixed save (array $object, [string $old_object_id = null])
  • array $object: The array that holds the data object
  • string $old_object_id: The id of the object if it existed before
saveObject (line 639)

Save the current object.

  • return: false if there is no open share, a PEAR error if the object could not be saved. True otherwise
  • deprecated:
mixed saveObject ( $xml,  $uid)
  • $xml
  • $uid
setObjectType (line 222)

Selects the type of data we are currently dealing with.

  • deprecated:
void setObjectType ( $type)
  • $type

Inherited Methods

Inherited From Kolab_Storage

 Kolab_Storage::getData()
 Kolab_Storage::getFolder()
 Kolab_Storage::getFolderData()
 Kolab_Storage::getShare()
 Kolab_Storage::getShareData()

Documentation generated on Sun, 30 Jan 2011 05:16:43 +0000 by phpDocumentor 1.4.3