Horde_Kolab_Storage_List_Query_List_Cache
extends Horde_Kolab_Storage_List_Query_List
in package
implements
Horde_Kolab_Storage_List_Manipulation_Listener, Horde_Kolab_Storage_List_Synchronization_Listener
The cached 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
Interfaces, Classes, Traits and Enums
- Horde_Kolab_Storage_List_Manipulation_Listener
- Describes a manipulation listener.
- Horde_Kolab_Storage_List_Synchronization_Listener
- Describes a synchronization listener.
Table of Contents
- ANNOTATION_FOLDER_TYPE = '/shared/vendor/kolab/folder-type'
- The folder type annotation
- BY_TYPE = 'BY_TYPE'
- The folder list sorted by type
- DEFAULTS = 'DEFAULTS'
- The default folder list
- FOLDERS = 'FOLDERS'
- The list of folder data
- OWNERS = 'OWNERS'
- The folder owner list
- PERSONAL_DEFAULTS = 'PERSONAL_DEFAULTS'
- The default folder list for the current user
- TYPES = 'TYPES'
- The list of folder types
- $_list_cache : Horde_Kolab_Storage_List_Cache
- The list cache.
- $_sync : Horde_Kolab_Storage_List_Query_List_Cache_Synchronization
- The synchronization handler.
- __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.
- getDuplicateDefaults() : array<string|int, mixed>
- Return any default folder duplicates.
- 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.
- synchronize() : mixed
- Synchronize the listener.
- updateAfterCreateFolder() : null
- Update the listener after creating a new folder.
- updateAfterDeleteFolder() : null
- Update the listener after deleting folder.
- updateAfterRenameFolder() : null
- Update the listener after renaming a folder.
- _initQuery() : null
- Ensure we have the query data.
Constants
ANNOTATION_FOLDER_TYPE
The folder type annotation
public
mixed
ANNOTATION_FOLDER_TYPE
= '/shared/vendor/kolab/folder-type'
BY_TYPE
The folder list sorted by type
public
mixed
BY_TYPE
= 'BY_TYPE'
DEFAULTS
The default folder list
public
mixed
DEFAULTS
= 'DEFAULTS'
FOLDERS
The list of folder data
public
mixed
FOLDERS
= 'FOLDERS'
OWNERS
The folder owner list
public
mixed
OWNERS
= 'OWNERS'
PERSONAL_DEFAULTS
The default folder list for the current user
public
mixed
PERSONAL_DEFAULTS
= 'PERSONAL_DEFAULTS'
TYPES
The list of folder types
public
mixed
TYPES
= 'TYPES'
Properties
$_list_cache
The list cache.
private
Horde_Kolab_Storage_List_Cache
$_list_cache
$_sync
The synchronization handler.
private
Horde_Kolab_Storage_List_Query_List_Cache_Synchronization
$_sync
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_List_Query_List_Cache_Synchronization $sync, Horde_Kolab_Storage_List_Cache $cache) : mixed
Parameters
- $sync : Horde_Kolab_Storage_List_Query_List_Cache_Synchronization
-
The synchronization handler..
- $cache : Horde_Kolab_Storage_List_Cache
-
The list cache.
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.
getDuplicateDefaults()
Return any default folder duplicates.
public
getDuplicateDefaults() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of duplicate default folders accessible to the current user.
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 —synchronize()
Synchronize the listener.
public
synchronize() : mixed
Return values
mixed —updateAfterCreateFolder()
Update the listener after creating a new folder.
public
updateAfterCreateFolder(string $folder[, string $type = null ]) : null
Parameters
- $folder : string
-
The path of the folder that has been created.
- $type : string = null
-
An optional type for the folder.
Return values
null —updateAfterDeleteFolder()
Update the listener after deleting folder.
public
updateAfterDeleteFolder(string $folder) : null
Parameters
- $folder : string
-
The path of the folder that has been deleted.
Return values
null —updateAfterRenameFolder()
Update the listener after renaming a folder.
public
updateAfterRenameFolder(string $old, string $new) : null
Parameters
- $old : string
-
The old path of the folder.
- $new : string
-
The new path of the folder.
Return values
null —_initQuery()
Ensure we have the query data.
private
_initQuery(string $query) : null
Parameters
- $query : string
-
The query data required.