API Documentation
\

\Horde_Kolab_Storage_List_Query_List_Defaults

Handles the list of default folders and protects against more than default of a single folder type.

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
rememberDefault()
getDefaults()
reset()
getPersonalDefaults()
markComplete()
isComplete()
getDuplicates()
No public properties found
No constants found
doubleDefault()
No protected properties found
N/A
No private methods found
$_complete
$_defaults
$_personal_defaults
$_duplicate_defaults
N/A

Properties

$_complete

$_complete : boolean

Has the list of defaults been assembled completely?

Type

boolean

$_defaults

$_defaults : array

The complete list of defaults.

Type

array

$_personal_defaults

$_personal_defaults : array

The complete list of personal defaults.

Type

array

$_duplicate_defaults

$_duplicate_defaults : array

A list of duplicate personal defaults.

Type

array

Methods

rememberDefault()

rememberDefault(string  $folder, string  $type, string  $owner, boolean  $personal)

Remember a default folder.

Parameters

string $folder

The folder name.
string $type

The folder type.
string $owner

The folder owner.
boolean $personal

Is this a folder owned by the current user?

getDefaults()

getDefaults() : array

Return the complete list of default folders available.

Returns

array —

The list of default folders accessible to the current user.

reset()

reset()

Reset the list of defaults.

getPersonalDefaults()

getPersonalDefaults() : array

Return the list of personal defaults of the current user.

Returns

array —

The list of default folder owned by the current user.

markComplete()

markComplete()

Mark the list of defaults as completed.

isComplete()

isComplete() : boolean

Query if the list of defaults has been completely assembled.

Returns

boolean —

True, if the list is complete.

getDuplicates()

getDuplicates() : array

Return any duplicates.

Returns

array —

The list of duplicate default folders accessible to the current user.

doubleDefault()

doubleDefault(string  $first, string  $second, string  $owner, string  $type)

React on detection of more than one default folder.

Parameters

string $first

The first default folder name.
string $second

The second default folder name.
string $owner

The folder owner.
string $type

The folder type.