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
Methods summary
public
|
|
public
null
|
#
setLogger( mixed $logger )
Set the logger.
Parameters
- $logger
- The log handler (must provide the warn() method).
Returns
null
|
public
null
|
|
public
Horde_Kolab_Storage_Data_Format
|
#
getFormat( )
Return the format handler.
Return the format handler.
Returns
Implementation of
|
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
|
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.
|