PHP Class Horde_Kolab_Storage_List_Query_List_Base, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Inheritance: extends Horde_Kolab_Storage_List_Query_List
Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Folder_Types $types, Horde_Kolab_Storage_List_Query_List_Defaults $defaults ) Constructor.
dataByType ( string $type ) : array List basic folder data for the folders of a specific type.
folderData ( string $folder ) : array List basic folder data for the specified folder.
getDefault ( string $type ) : string | boolean Get the default folder for a certain type.
getForeignDefault ( string $owner, string $type ) : string | boolean Get the default folder for a certain type from a different owner.
getStamp ( ) : string Return the last sync stamp.
listByType ( string $type ) : array List all folders of a specific type.
listDefaults ( ) : array Return the list of default folders.
listOwners ( ) : array Get the folder owners.
listPersonalDefaults ( ) : array Return the list of personal default folders.
listTypes ( ) : array Returns the folder types as associative array.
setDefault ( string $folder ) Set the specified folder as default for its current type.

Private Methods

Method Description
_getDefaults ( ) Return the complete list of defaults.
_getPersonalDefaults ( ) Return the list of personal defaults.
_initDefaults ( ) Initialize the list of defaults.
listFolderTypeAnnotations ( ) : array Returns the folder type annotation as associative array.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Folder_Types $types, Horde_Kolab_Storage_List_Query_List_Defaults $defaults )
$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.

dataByType() public method

List basic folder data for the folders of a specific type.
public dataByType ( string $type ) : array
$type string The folder type the listing should be limited to.
return array The list of folders.

folderData() public method

List basic folder data for the specified folder.
public folderData ( string $folder ) : array
$folder string The folder path.
return array The folder data.

getDefault() public method

Get the default folder for a certain type.
public getDefault ( string $type ) : string | boolean
$type string The type of the share/folder.
return string | boolean The name of the default folder, false if there is no default.

getForeignDefault() public method

Get the default folder for a certain type from a different owner.
public getForeignDefault ( string $owner, string $type ) : string | boolean
$owner string The folder owner.
$type string The type of the share/folder.
return string | boolean The name of the default folder, false if there is no default.

getStamp() public method

Return the last sync stamp.
public getStamp ( ) : string
return string The stamp.

listByType() public method

List all folders of a specific type.
public listByType ( string $type ) : array
$type string The folder type the listing should be limited to.
return array The list of folders.

listDefaults() public method

Return the list of default folders.
public listDefaults ( ) : array
return array An array with owners as keys and another array as value. The second array associates type (key) with the corresponding default folder (value).

listOwners() public method

Get the folder owners.
public listOwners ( ) : array
return array The folder owners with the folder names as key and the owner as values.

listPersonalDefaults() public method

Return the list of personal default folders.
public listPersonalDefaults ( ) : array
return array An array that associates type (key) with the corresponding default folder name (value).

listTypes() public method

Returns the folder types as associative array.
public listTypes ( ) : array
return array The list folder types with the folder names as key and the type as values.

setDefault() public method

Set the specified folder as default for its current type.
public setDefault ( string $folder )
$folder string The folder name.