Class Horde_Kolab_Storage_List_Base

The basic handler for accessing folder lists from Kolab storage.

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_List_Base implements Horde_Kolab_Storage_List, Horde_Kolab_Storage_List_Query

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/List/Base.php

Methods summary
`public`	# `__construct( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Factory $factory )` Constructor. Constructor. Parameters `$driver` The primary connection driver. `$factory` The factory.
`public Horde_Kolab_Storage_Driver`	# `getDriver( )` Return the list driver. Return the list driver. Returns `Horde_Kolab_Storage_Driver` The driver. Implementation of `Horde_Kolab_Storage_List::getDriver()`
`public string`	# `getId( )` Return the ID of the underlying connection. Return the ID of the underlying connection. Returns `string` The connection ID. Implementation of `Horde_Kolab_Storage_List::getId()`
`public array`	# `getIdParameters( )` Return the connection parameters. Return the connection parameters. Returns `array` The connection parameters. Implementation of `Horde_Kolab_Storage_List::getIdParameters()`
`public null`	# `createFolder( string $folder, string $type = null )` Create a new folder. Create a new folder. Parameters `$folder` The path of the folder to create. `$type` An optional type for the folder. Returns `null` Implementation of `Horde_Kolab_Storage_List_Query::createFolder()`
`public null`	# `deleteFolder( string $folder )` Delete a folder. Delete a folder. WARNING: Do not use this call in case there is still data present in the folder. You are required to empty any data set before removing the folder. Otherwise there is no guarantee you can adhere to that Kolab specification that might require the triggering of remote systems to inform them about the removal of the folder. Parameters `$folder` The path of the folder to delete. Returns `null` Implementation of `Horde_Kolab_Storage_List_Query::deleteFolder()`
`public null`	# `renameFolder( string $old, string $new )` Rename a folder. Rename a folder. Parameters `$old` The old path of the folder. `$new` The new path of the folder. Returns `null` Implementation of `Horde_Kolab_Storage_List_Query::renameFolder()`
`public Horde_Kolab_Storage_Folder`	# `getFolder( string $folder )` Returns a representation for the requested folder. Returns a representation for the requested folder. Parameters `$folder` The path of the folder to return. Returns `Horde_Kolab_Storage_Folder` The folder representation. Implementation of `Horde_Kolab_Storage_List::getFolder()`
`public null`	# `setDefault( string $folder )` Mark the specified folder as the default folder of this type. Mark the specified folder as the default folder of this type. Parameters `$folder` The path of the folder to mark as default. Returns `null` Implementation of `Horde_Kolab_Storage_List::setDefault()`
`public array`	# `listFolders( )` Returns the list of folders visible to the current user. Returns the list of folders visible to the current user. Returns `array` The list of folders, represented as a list of strings. Implementation of `Horde_Kolab_Storage_List::listFolders()`
`public array`	# `listFolderTypes( )` Returns the folder type annotation as associative array. Returns the folder type annotation as associative array. Returns `array` The list folder types with the folder names as key and the folder type as values. Implementation of `Horde_Kolab_Storage_List::listFolderTypes()`
`public Horde_Kolab_Storage_Folder_Namespace`	# `getNamespace( )` Returns the namespace for the list. Returns the namespace for the list. Returns `Horde_Kolab_Storage_Folder_Namespace` The namespace handler. Implementation of `Horde_Kolab_Storage_List::getNamespace()`
`public string`	# `getStamp( )` Return the last sync stamp. Return the last sync stamp. Returns `string` The stamp. Implementation of `Horde_Kolab_Storage_List_Query::getStamp()`
`public null`	# `synchronize( array $params = array() )` Synchronize the list information with the information from the backend. Synchronize the list information with the information from the backend. Parameters `$params` Additional parameters. Returns `null` Implementation of `Horde_Kolab_Storage_Query::synchronize()`
`public null`	# `registerQuery( string $name, Horde_Kolab_Storage_Query $query )` Register a query to be updated if the underlying data changes. Register a query to be updated if the underlying data changes. Parameters `$name` The query name. `$query` The query to register. Returns `null` Implementation of `Horde_Kolab_Storage_Queriable::registerQuery()`
`public Horde_Kolab_Storage_Query`	# `getQuery( string $name = null )` Return a registered query. Return a registered query. Parameters `$name` The query name. Returns `Horde_Kolab_Storage_Query` The requested query. Throws `Horde_Kolab_Storage_Exception` In case the requested query does not exist. Implementation of `Horde_Kolab_Storage_Queriable::getQuery()`

Constants summary
`string`	`ANNOTATION_FOLDER_TYPE` The folder type annotation The folder type annotation	# `'/shared/vendor/kolab/folder-type'`

Constants inherited from Horde_Kolab_Storage_List
`QUERY_ACL, QUERY_BASE, QUERY_SHARE`

Packages

Classes

Interfaces

Class Horde_Kolab_Storage_List_Base

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of