PHP Class Horde_Kolab_Storage_List_Query_List_Defaults, 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.
See link: http://pear.horde.org/index.php?package=Kolab_Storage
Author: Gunnar Wrobel ([email protected])
Exibir arquivo Open project: horde/horde Class Usage Examples

Public Methods

Method Description
getDefaults ( ) : array Return the complete list of default folders available.
getDuplicates ( ) : array Return any duplicates.
getPersonalDefaults ( ) : array Return the list of personal defaults of the current user.
isComplete ( ) : boolean Query if the list of defaults has been completely assembled.
markComplete ( ) Mark the list of defaults as completed.
rememberDefault ( string $folder, string $type, string $owner, boolean $personal ) Remember a default folder.
reset ( ) Reset the list of defaults.

Protected Methods

Method Description
doubleDefault ( string $first, string $second, string $owner, string $type ) React on detection of more than one default folder.

Method Details

doubleDefault() abstract protected method

React on detection of more than one default folder.
abstract protected doubleDefault ( string $first, string $second, string $owner, string $type )
$first string The first default folder name.
$second string The second default folder name.
$owner string The folder owner.
$type string The folder type.

getDefaults() public method

Return the complete list of default folders available.
public getDefaults ( ) : array
return array The list of default folders accessible to the current user.

getDuplicates() public method

Return any duplicates.
public getDuplicates ( ) : array
return array The list of duplicate default folders accessible to the current user.

getPersonalDefaults() public method

Return the list of personal defaults of the current user.
public getPersonalDefaults ( ) : array
return array The list of default folder owned by the current user.

isComplete() public method

Query if the list of defaults has been completely assembled.
public isComplete ( ) : boolean
return boolean True, if the list is complete.

markComplete() public method

Mark the list of defaults as completed.
public markComplete ( )

rememberDefault() public method

Remember a default folder.
public rememberDefault ( string $folder, string $type, string $owner, boolean $personal )
$folder string The folder name.
$type string The folder type.
$owner string The folder owner.
$personal boolean Is this a folder owned by the current user?

reset() public method

Reset the list of defaults.
public reset ( )