Class Horde_Kolab_Storage_Base
The basis for Kolab storage access.
Copyright 2004-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_Base
implements
Horde_Kolab_Storage
Methods summary
public
|
#
__construct( Horde_Kolab_Storage_Driver $master, Horde_Kolab_Storage_QuerySet $query_set, Horde_Kolab_Storage_Factory $factory, array $params = array() )
Constructor.
Parameters
- $master
- <p>The primary connection
driver.</p>
- $query_set
- The query handler.
- $factory
- The factory.
- $params
- Additional parameters.
<pre>- <span class="php-keyword2">system</span> [<span class="php-keyword1">array</span>]: A <span class="php-keyword1">list</span> of credentials <span class="php-keyword1">for</span> <span class="php-keyword2">system</span> users.
<span class="php-keyword2">Each</span> entry has the <span class="php-keyword2">system</span> user type <span class="php-keyword1">as</span> <span class="php-keyword2">key</span> <span class="php-keyword1">and</span>
another <span class="php-keyword1">array</span> <span class="php-keyword1">as</span> value. The latter needs to provide
both <span class="php-quote">'username'</span> <span class="php-keyword1">and</span> <span class="php-quote">'password'</span> <span class="php-keyword1">for</span> the <span class="php-keyword2">system</span> user.
A <span class="php-keyword2">key</span> of <span class="php-quote">''</span> indicates the <span class="php-keyword1">default</span> <span class="php-keyword2">system</span> user.</pre>
|
public
Horde_Kolab_Storage_List
|
#
getSystemList( string $type )
Get a folder list object for a "system" user.
Get a folder list object for a "system" user.
Parameters
- $type
- The type of system user.
Returns
Implementation of
|
public
Horde_Kolab_Storage_List
|
#
getList( Horde_Kolab_Storage_Driver $driver = null )
Get the folder list object.
Get the folder list object.
Returns
Params
Horde_Kolab_Storage_Driver $driver Optional driver as backend
for the list.
Implementation of
|
public
Horde_Kolab_Storage_Folder
|
#
getFolder( string $folder )
Get a Folder object.
Parameters
Returns
Implementation of
|
public
Horde_Kolab_Data
|
#
getData( mixed $folder, string $object_type = null, integer $data_version = 1 )
Return a data handler for accessing data in the specified folder.
Return a data handler for accessing data in the specified folder.
Parameters
- $folder
- <p>The name of the folder or an instance
representing the folder.</p>
- $object_type
- <p>The type of data we want to access in the
folder.</p>
- $data_version
- Format version of the object data.
Returns
Horde_Kolab_Data
The data object.
Implementation of
|