Interface Horde_Kolab_Storage_List_Query_List

The interface of the basic list query.

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_Query_List implements Horde_Kolab_Storage_List_Query

Direct known implementers

Horde_Kolab_Storage_List_Query_List_Base, Horde_Kolab_Storage_List_Query_List_Cache

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

Methods summary
`public array`	# `listTypes( )` Returns the folder types as associative array. Returns the folder types as associative array. Returns `array` The list folder types with the folder names as key and the type as values.
`public array`	# `listFolderTypeAnnotations( )` 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 type handler as values.
`public array`	# `dataByType( string $type )` List basic folder data for the folders of a specific type. List basic folder data for the folders of a specific type. Parameters `$type` The folder type the listing should be limited to. Returns `array` The list of folders.
`public array`	# `folderData( string $folder )` List basic folder data for the specified folder. List basic folder data for the specified folder. Parameters `$folder` The folder path. Returns `array` The folder data.
`public array`	# `listByType( string $type )` List all folders of a specific type. List all folders of a specific type. Parameters `$type` The folder type the listing should be limited to. Returns `array` The list of folders.
`public array`	# `listOwners( )` Get the folder owners. Get the folder owners. Returns `array` The folder owners with the folder names as key and the owner as values.
`public array`	# `listDefaults( )` Return the list of default folders. Return the list of default folders. Returns `array` An array with owners as keys and another array as value. The second array associates type (key) with the corresponding default folder (value).
`public string\|boolean`	# `getDefault( string $type )` Get the default folder for a certain type. Get the default folder for a certain type. Parameters `$type` The type of the share/folder. Returns `string\|boolean` The name of the default folder, false if there is no default.
`public string\|boolean`	# `getForeignDefault( string $owner, string $type )` Get the default folder for a certain type from a different owner. Get the default folder for a certain type from a different owner. Parameters `$owner` The folder owner. `$type` The type of the share/folder. Returns `string\|boolean` The name of the default folder, false if there is no default.

Methods inherited from Horde_Kolab_Storage_List_Query
`createFolder(), deleteFolder(), getStamp(), renameFolder()`

Methods inherited from Horde_Kolab_Storage_Query
`synchronize()`

Packages

Classes

Interfaces

Interface Horde_Kolab_Storage_List_Query_List

Direct known implementers

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns