Horde_Kolab_Storage_List_Query_List_Defaults_Bail
extends Horde_Kolab_Storage_List_Query_List_Defaults
in package
Protects against more than one default folder per type by bailing out.
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
- $_complete : bool
- Has the list of defaults been assembled completely?
- $_defaults : array<string|int, mixed>
- The complete list of defaults.
- $_duplicate_defaults : array<string|int, mixed>
- A list of duplicate personal defaults.
- $_personal_defaults : array<string|int, mixed>
- The complete list of personal defaults.
- getDefaults() : array<string|int, mixed>
- Return the complete list of default folders available.
- getDuplicates() : array<string|int, mixed>
- Return any duplicates.
- getPersonalDefaults() : array<string|int, mixed>
- Return the list of personal defaults of the current user.
- isComplete() : bool
- Query if the list of defaults has been completely assembled.
- markComplete() : mixed
- Mark the list of defaults as completed.
- rememberDefault() : mixed
- Remember a default folder.
- reset() : mixed
- Reset the list of defaults.
- doubleDefault() : mixed
- React on detection of more than one default folder.
Properties
$_complete
Has the list of defaults been assembled completely?
private
bool
$_complete
= \false
$_defaults
The complete list of defaults.
private
array<string|int, mixed>
$_defaults
= array()
$_duplicate_defaults
A list of duplicate personal defaults.
private
array<string|int, mixed>
$_duplicate_defaults
= array()
$_personal_defaults
The complete list of personal defaults.
private
array<string|int, mixed>
$_personal_defaults
= array()
Methods
getDefaults()
Return the complete list of default folders available.
public
getDefaults() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of default folders accessible to the current user.
getDuplicates()
Return any duplicates.
public
getDuplicates() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of duplicate default folders accessible to the current user.
getPersonalDefaults()
Return the list of personal defaults of the current user.
public
getPersonalDefaults() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of default folder owned by the current user.
isComplete()
Query if the list of defaults has been completely assembled.
public
isComplete() : bool
Return values
bool —True, if the list is complete.
markComplete()
Mark the list of defaults as completed.
public
markComplete() : mixed
Return values
mixed —rememberDefault()
Remember a default folder.
public
rememberDefault(string $folder, string $type, string $owner, bool $personal) : mixed
Parameters
- $folder : string
-
The folder name.
- $type : string
-
The folder type.
- $owner : string
-
The folder owner.
- $personal : bool
-
Is this a folder owned by the current user?
Return values
mixed —reset()
Reset the list of defaults.
public
reset() : mixed
Return values
mixed —doubleDefault()
React on detection of more than one default folder.
protected
doubleDefault(string $first, string $second, string $owner, string $type) : mixed
Parameters
- $first : string
-
The first default folder name.
- $second : string
-
The second default folder name.
- $owner : string
-
The folder owner.
- $type : string
-
The folder type.