Horde_Kolab_Storage_List_Query_List
in package
The interface of 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.
Tags
Table of Contents
- ANNOTATION_FOLDER_TYPE = '/shared/vendor/kolab/folder-type'
- The folder type annotation
- dataByType() : array<string|int, mixed>
- List basic folder data for the folders of a specific type.
- folderData() : array<string|int, mixed>
- List basic folder data for the specified folder.
- getDefault() : string|bool
- Get the default folder for a certain type.
- getForeignDefault() : string|bool
- Get the default folder for a certain type from a different owner.
- getStamp() : string
- Return the last sync stamp.
- listByType() : array<string|int, mixed>
- List all folders of a specific type.
- listDefaults() : array<string|int, mixed>
- Return the list of default folders.
- listOwners() : array<string|int, mixed>
- Get the folder owners.
- listTypes() : array<string|int, mixed>
- Returns the folder types as associative array.
Constants
ANNOTATION_FOLDER_TYPE
The folder type annotation
public
mixed
ANNOTATION_FOLDER_TYPE
= '/shared/vendor/kolab/folder-type'
Methods
dataByType()
List basic folder data for the folders of a specific type.
public
abstract dataByType(string $type) : array<string|int, mixed>
Parameters
- $type : string
-
The folder type the listing should be limited to.
Return values
array<string|int, mixed> —The list of folders.
folderData()
List basic folder data for the specified folder.
public
abstract folderData(string $folder) : array<string|int, mixed>
Parameters
- $folder : string
-
The folder path.
Return values
array<string|int, mixed> —The folder data.
getDefault()
Get the default folder for a certain type.
public
abstract getDefault(string $type) : string|bool
Parameters
- $type : string
-
The type of the share/folder.
Return values
string|bool —The name of the default folder, false if there is no default.
getForeignDefault()
Get the default folder for a certain type from a different owner.
public
abstract getForeignDefault(string $owner, string $type) : string|bool
Parameters
- $owner : string
-
The folder owner.
- $type : string
-
The type of the share/folder.
Return values
string|bool —The name of the default folder, false if there is no default.
getStamp()
Return the last sync stamp.
public
abstract getStamp() : string
Return values
string —The stamp.
listByType()
List all folders of a specific type.
public
abstract listByType(string $type) : array<string|int, mixed>
Parameters
- $type : string
-
The folder type the listing should be limited to.
Return values
array<string|int, mixed> —The list of folders.
listDefaults()
Return the list of default folders.
public
abstract listDefaults() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array with owners as keys and another array as value. The second array associates type (key) with the corresponding default folder (value).
listOwners()
Get the folder owners.
public
abstract listOwners() : array<string|int, mixed>
Return values
array<string|int, mixed> —The folder owners with the folder names as key and the owner as values.
listTypes()
Returns the folder types as associative array.
public
abstract listTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list folder types with the folder names as key and the type as values.