API Documentation
\

\Horde_Kolab_Storage_List_Query_List_Base

The basic list query.

Copyright 2010-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
listTypes()
dataByType()
folderData()
listByType()
listOwners()
listDefaults()
getDefault()
getForeignDefault()
getStamp()
__construct()
setDefault()
listPersonalDefaults()
No public properties found
ANNOTATION_FOLDER_TYPE
No protected methods found
No protected properties found
N/A
listFolderTypeAnnotations()
_getPersonalDefaults()
_getDefaults()
_initDefaults()
$_driver
$_folder_types
$_defaults
N/A

Constants

ANNOTATION_FOLDER_TYPE

ANNOTATION_FOLDER_TYPE

The folder type annotation

Properties

Methods

listTypes()

listTypes() : 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.

dataByType()

dataByType(string  $type) : array

List basic folder data for the folders of a specific type.

Parameters

string $type

The folder type the listing should be limited to.

Returns

array —

The list of folders.

folderData()

folderData(string  $folder) : array

List basic folder data for the specified folder.

Parameters

string $folder

The folder path.

Returns

array —

The folder data.

listByType()

listByType(string  $type) : array

List all folders of a specific type.

Parameters

string $type

The folder type the listing should be limited to.

Returns

array —

The list of folders.

listOwners()

listOwners() : array

Get the folder owners.

Returns

array —

The folder owners with the folder names as key and the owner as values.

listDefaults()

listDefaults() : array

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

getDefault()

getDefault(string  $type) : string|boolean

Get the default folder for a certain type.

Parameters

string $type

The type of the share/folder.

Returns

string|boolean —

The name of the default folder, false if there is no default.

getForeignDefault()

getForeignDefault(string  $owner, string  $type) : string|boolean

Get the default folder for a certain type from a different owner.

Parameters

string $owner

The folder owner.
string $type

The type of the share/folder.

Returns

string|boolean —

The name of the default folder, false if there is no default.

getStamp()

getStamp() : string

Return the last sync stamp.

Returns

string —

The stamp.

setDefault()

setDefault(string  $folder)

Set the specified folder as default for its current type.

Parameters

string $folder

The folder name.

listPersonalDefaults()

listPersonalDefaults() : array

Return the list of personal default folders.

Returns

array —

An array that associates type (key) with the corresponding default folder name (value).

listFolderTypeAnnotations()

listFolderTypeAnnotations() : 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.

_getPersonalDefaults()

_getPersonalDefaults()

Return the list of personal defaults.

_getDefaults()

_getDefaults()

Return the complete list of defaults.

_initDefaults()

_initDefaults()

Initialize the list of defaults.