Horde_Kolab_Storage_List_Query_List_Base
extends Horde_Kolab_Storage_List_Query_List
in package
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
- $_defaults : Horde_Kolab_Storage_List_Query_List_Defaults
- Handles default folders.
- $_driver : Horde_Kolab_Storage_Driver
- The IMAP driver to query the backend.
- $_folder_types : Horde_Kolab_Storage_Folder_Types
- The factory for folder types.
- __construct() : mixed
- Constructor.
- 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.
- listPersonalDefaults() : array<string|int, mixed>
- Return the list of personal default folders.
- listTypes() : array<string|int, mixed>
- Returns the folder types as associative array.
- setDefault() : mixed
- Set the specified folder as default for its current type.
- _getDefaults() : mixed
- Return the complete list of defaults.
- _getPersonalDefaults() : mixed
- Return the list of personal defaults.
- _initDefaults() : mixed
- Initialize the list of defaults.
- listFolderTypeAnnotations() : array<string|int, mixed>
- Returns the folder type annotation as associative array.
Constants
ANNOTATION_FOLDER_TYPE
The folder type annotation
public
mixed
ANNOTATION_FOLDER_TYPE
= '/shared/vendor/kolab/folder-type'
Properties
$_defaults
Handles default folders.
private
Horde_Kolab_Storage_List_Query_List_Defaults
$_defaults
$_driver
The IMAP driver to query the backend.
private
Horde_Kolab_Storage_Driver
$_driver
$_folder_types
The factory for folder types.
private
Horde_Kolab_Storage_Folder_Types
$_folder_types
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Folder_Types $types, Horde_Kolab_Storage_List_Query_List_Defaults $defaults) : mixed
Parameters
- $driver : Horde_Kolab_Storage_Driver
-
The driver to access the backend.
- $types : Horde_Kolab_Storage_Folder_Types
-
Handler of folder types.
- $defaults : Horde_Kolab_Storage_List_Query_List_Defaults
-
Handler of defaults.
Return values
mixed —dataByType()
List basic folder data for the folders of a specific type.
public
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
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
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
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
getStamp() : string
Return values
string —The stamp.
listByType()
List all folders of a specific type.
public
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
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
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.
listPersonalDefaults()
Return the list of personal default folders.
public
listPersonalDefaults() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array that associates type (key) with the corresponding default folder name (value).
listTypes()
Returns the folder types as associative array.
public
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.
setDefault()
Set the specified folder as default for its current type.
public
setDefault(string $folder) : mixed
Parameters
- $folder : string
-
The folder name.
Return values
mixed —_getDefaults()
Return the complete list of defaults.
private
_getDefaults() : mixed
Return values
mixed —_getPersonalDefaults()
Return the list of personal defaults.
private
_getPersonalDefaults() : mixed
Return values
mixed —_initDefaults()
Initialize the list of defaults.
private
_initDefaults() : mixed
Return values
mixed —listFolderTypeAnnotations()
Returns the folder type annotation as associative array.
private
listFolderTypeAnnotations() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list folder types with the folder names as key and the type handler as values.