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_Parser_Structure

Parses an object by relying on the MIME capabilities of the backend. er.

Copyright 2011-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_Data_Parser_Structure implements Horde_Kolab_Storage_Data_Parser
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/Data/Parser/Structure.php
Methods summary
public
# __construct( Horde_Kolab_Storage_Driver $driver )

Constructor

Constructor

Parameters

$driver
The backend driver.
public null
# setLogger( mixed $logger )

Set the logger.

Set the logger.

Parameters

$logger
The log handler (must provide the warn() method).

Returns

null
public null
# setFormat( Horde_Kolab_Storage_Data_Format $format )

Set the format handler.

Set the format handler.

Parameters

$format
<p>The data object <-> format bridge.</p>

Returns

null
public Horde_Kolab_Storage_Data_Format
# getFormat( )

Return the format handler.

Return the format handler.

Returns

Horde_Kolab_Storage_Data_Format

The data object <-> format bridge.

Implementation of

Horde_Kolab_Storage_Data_Parser::getFormat()
public array
# fetch( string $folder, array $obids, array $options = array() )

Fetches the objects for the specified backend IDs.

Fetches the objects for the specified backend IDs.

Parameters

$folder
The folder to access.
$obids
The object backend IDs to fetch.
$options
Additional options for fetching. <pre><span class="php-quote">'type'</span> - Required argument specifying the object type that should be parsed. <span class="php-quote">'version'</span> - Optional argument specifying the version of the object format.</pre>

Returns

array
The objects.

Implementation of

Horde_Kolab_Storage_Data_Parser::fetch()
public resource
# fetchId( string $folder, string $obid, string $mime_id )

Fetch the specified mime part.

Fetch the specified mime part.

Parameters

$folder
The folder to access.
$obid
The backend ID to parse from.
$mime_id
The ID of the part that should be fetched.

Returns

resource
A stream for the specified body part.
public string
# create( string $folder, array $object, array $options = array() )

Create a new object in the specified folder.

Create a new object in the specified folder.

Parameters

$folder
The folder to use.
$object
The object.
$options
Additional options for storing. <pre><span class="php-quote">'type'</span> - Required argument specifying the object type that should be stored. <span class="php-quote">'version'</span> - Optional argument specifying the version of the object format.</pre>

Returns

string

The ID of the new object or true in case the backend does not support this return value.
public string
# modify( string $folder, array $object, string $obid, array $options = array() )

Modify an existing object in the specified folder.

Modify an existing object in the specified folder.

Parameters

$folder
The folder to use.
$object
The object.
$obid
The object ID in the backend.
$options
Additional options for storing. <pre><span class="php-quote">'type'</span> - Required argument specifying the object type that should be stored. <span class="php-quote">'version'</span> - Optional argument specifying the version of the object format.</pre>

Returns

string

The ID of the modified object or true in case the backend does not support this return value.
public resource
# createObject( array $object, array $options = array() )

Create a new MIME representation for the object.

Create a new MIME representation for the object.

Parameters

$object
The object.
$options
Additional options for storing. <pre><span class="php-quote">'type'</span> - Required argument specifying the object type that should be stored. <span class="php-quote">'version'</span> - Optional argument specifying the version of the object format.</pre>

Returns

resource
The MIME message representing the object.
API documentation generated by ApiGen