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_Driver_Base

The base driver definition for accessing Kolab storage drivers.

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.

Horde_Kolab_Storage_Driver_Base implements Horde_Kolab_Storage_Driver

Direct known subclasses

Horde_Kolab_Storage_Driver_Cclient, Horde_Kolab_Storage_Driver_Imap, Horde_Kolab_Storage_Driver_Mock, Horde_Kolab_Storage_Driver_Pear, Horde_Kolab_Storage_Driver_Rcube
Abstract
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/Driver/Base.php
Methods summary
public
# __construct( Horde_Kolab_Storage_Factory $factory, array $params = array() )

Constructor.

Constructor.

Parameters

$factory
A factory for helper objects.
$params
Connection parameters.
public mixed
# getBackend( )

Returns the actual backend driver.

Returns the actual backend driver.

If there is no driver set the driver should be constructed within this method.

Returns

mixed
The backend driver.

Implementation of

Horde_Kolab_Storage_Driver::getBackend()
public null
# setBackend( mixed $backend )

Set the backend driver.

Set the backend driver.

Parameters

$backend
The driver that should be used.

Returns

null

Implementation of

Horde_Kolab_Storage_Driver::setBackend()
public Horde_Kolab_Storage_Data_Parser
# getParser( )

Returns the parser for data objects.

Returns the parser for data objects.

Returns

Horde_Kolab_Storage_Data_Parser
The parser.

Implementation of

Horde_Kolab_Storage_Driver::getParser()
public null
# setParser( Horde_Kolab_Storage_Data_Parser $parser )

Set the data parser.

Set the data parser.

Parameters

$parser
The parser that should be used.

Returns

null

Implementation of

Horde_Kolab_Storage_Driver::setParser()
public array
# getParams( )

Return all parameter settings for this connection.

Return all parameter settings for this connection.

Returns

array
The parameters.
public mixed
# getParam( string $key, mixed $default = null )

Return a parameter setting for this connection.

Return a parameter setting for this connection.

Parameters

$key
The parameter key.
$default
An optional default value.

Returns

mixed
The parameter value.
public null
# setParam( string $key, mixed $value )

Set a parameter setting for this connection.

Set a parameter setting for this connection.

Parameters

$key
The parameter key.
$value
The parameter value.

Returns

null
public string
# getAuth( )

Return the id of the user currently authenticated.

Return the id of the user currently authenticated.

Returns

string
The id of the user that opened the IMAP connection.

Implementation of

Horde_Kolab_Storage_Driver::getAuth()
public string
# getId( )

Return the unique connection id.

Return the unique connection id.

Returns

string
The connection id.

Implementation of

Horde_Kolab_Storage_Driver::getId()
public array
# getParameters( )

Return the connection parameters.

Return the connection parameters.

Returns

array
The connection parameters.

Implementation of

Horde_Kolab_Storage_Driver::getParameters()
public boolean
# hasCatenateSupport( )

Checks if the backend supports CATENATE.

Checks if the backend supports CATENATE.

Returns

boolean
True if the backend supports CATENATE.

Implementation of

Horde_Kolab_Storage_Driver::hasCatenateSupport()
public Horde_Kolab_Storage_Driver_Modifiable
# getModifiable( string $folder, string $obid, array $object )

Return a modifiable message object.

Return a modifiable message object.

Parameters

$folder
The folder to access.
$obid
The backend ID of the object to retrieve from the folder.
$object
The object data.

Returns

Horde_Kolab_Storage_Driver_Modifiable
The modifiable message object.
public Horde_Kolab_Storage_Folder_Namespace
# getNamespace( )

Retrieve the namespace information for this connection.

Retrieve the namespace information for this connection.

Returns

Horde_Kolab_Storage_Folder_Namespace
The initialized namespace handler.

Implementation of

Horde_Kolab_Storage_Driver::getNamespace()
public Horde_Kolab_Storage_Folder_Stamp
# getStamp( string $folder )

Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data.

Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data.

Parameters

$folder
Return the stamp for this folder.

Returns

Horde_Kolab_Storage_Folder_Stamp

A stamp indicating the current folder status.

Implementation of

Horde_Kolab_Storage_Driver::getStamp()
public array
# fetch( string $folder, array $uids, array $options = array() )

Fetches the objects for the specified UIDs.

Fetches the objects for the specified UIDs.

Parameters

$folder
The folder to access.
$uids
The message UIDs.
$options
Additional options. <pre>- type - (string) The data type. - version - (int) The format version. - raw - (bool) Should the raw data be returned?</pre>

Returns

array
The objects.

Implementation of

Horde_Kolab_Storage_Driver::fetch()
public Horde_Mime_Part
# fetchStructure( string $mailbox, array $uids )

Retrieves the messages for the given message ids.

Retrieves the messages for the given message ids.

Parameters

$mailbox
The mailbox to fetch the messages from.
$uids
The message UIDs.

Returns

Horde_Mime_Part

The message structure parsed into a Horde_Mime_Part instance.

Implementation of

Horde_Kolab_Storage_Driver::fetchStructure()
public resource
# fetchBodypart( string $mailbox, array $uid, array $id )

Retrieves a bodypart for the given message ID and mime part ID.

Retrieves a bodypart for the given message ID and mime part ID.

Parameters

$mailbox
The mailbox to fetch the messages from.
$uid
The message UID.
$id
The mime part ID.

Returns

resource
The body part, in a stream resource.

Implementation of

Horde_Kolab_Storage_Driver::fetchBodypart()
public array
# fetchComplete( string $folder, array $uid )

Retrieves a complete message.

Retrieves a complete message.

Parameters

$folder
The folder to fetch the messages from.
$uid
The message UID.

Returns

array

The message encapsuled as an array that contains a Horde_Mime_Headers and a Horde_Mime_Part object.

Implementation of

Horde_Kolab_Storage_Driver::fetchComplete()
Methods inherited from Horde_Kolab_Storage_Driver
appendMessage(), create(), createBackend(), delete(), deleteAcl(), deleteMessages(), expunge(), getAcl(), getAnnotation(), getMyAcl(), getUids(), hasAclSupport(), listAnnotation(), listFolders(), moveMessage(), rename(), setAcl(), setAnnotation(), status()
API documentation generated by ApiGen