Interface Horde_Kolab_Storage_List

The interface describing a list of Kolab folders.

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 implements Horde_Kolab_Storage_Queriable

Direct known implementers

Horde_Kolab_Storage_List_Base, Horde_Kolab_Storage_List_Decorator_Cache, Horde_Kolab_Storage_List_Decorator_Log

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.php

Methods summary
`public Horde_Kolab_Storage_Driver`	# `getDriver( )` Return the list driver. Return the list driver. Returns `Horde_Kolab_Storage_Driver` The driver.
`public string`	# `getId( )` Return the ID of the underlying connection. Return the ID of the underlying connection. Returns `string` The connection ID.
`public array`	# `getIdParameters( )` Return the connection parameters. Return the connection parameters. Returns `array` The connection parameters.
`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.
`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`
`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 strings.
`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.
`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.

Methods inherited from Horde_Kolab_Storage_Queriable
`getQuery(), registerQuery()`

Constants summary
`string`	`QUERY_BASE` Identifies the basic list query Identifies the basic list query	# `'List'`
`string`	`QUERY_ACL` Identifies the ACL query Identifies the ACL query	# `'Acl'`
`string`	`QUERY_SHARE` Identifies the share query Identifies the share query	# `'Share'`

Packages

Classes

Interfaces

Interface Horde_Kolab_Storage_List

Direct known implementers

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns