Horde_Kolab_Storage_List_Query_List_Cache_Synchronization
in package
Handles synchronization of the list query cache.
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
- $_cache : Horde_Kolab_Storage_List_Cache
- The list cache.
- $_defaults : Horde_Kolab_Storage_List_Query_List_Defaults
- Handles default folders.
- $_driver : Horde_Kolab_Storage_Driver
- The IMAP driver to query the backend.
- $_folder_types : Horde_Kolab_Storage_Folder_Types
- The factory for folder types.
- __construct() : mixed
- Constructor.
- _synchronize() : null
- Synchronize based on the given folder list.
- getDuplicateDefaults() : array<string|int, mixed>
- Return any default folder duplicates.
- setCache() : mixed
- Set the list cache.
- setDefault() : mixed
- Set the specified folder as default for its current type.
- synchronize() : mixed
- Synchronize the query data with the information from the backend.
- 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.
Properties
$_cache
The list cache.
private
Horde_Kolab_Storage_List_Cache
$_cache
$_defaults
Handles default folders.
private
Horde_Kolab_Storage_List_Query_List_Defaults
$_defaults
$_driver
The IMAP driver to query the backend.
private
Horde_Kolab_Storage_Driver
$_driver
$_folder_types
The factory for folder types.
private
Horde_Kolab_Storage_Folder_Types
$_folder_types
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Folder_Types $types, Horde_Kolab_Storage_List_Query_List_Defaults $defaults) : mixed
Parameters
- $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
Return values
mixed —_synchronize()
Synchronize based on the given folder list.
public
_synchronize(Horde_Kolab_Storage_Folder_Namespace $namespace, array<string|int, mixed> $folder_list, mixed $annotations) : null
Parameters
- $namespace : Horde_Kolab_Storage_Folder_Namespace
-
The namespace handler
- $folder_list : array<string|int, mixed>
-
The list of folders.
- $annotations : mixed
Return values
null —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.
setCache()
Set the list cache.
public
setCache(Horde_Kolab_Storage_List_Cache $cache) : mixed
Parameters
- $cache : Horde_Kolab_Storage_List_Cache
-
The reference to the cache that should reveive any updates.
Return values
mixed —setDefault()
Set the specified folder as default for its current type.
public
setDefault(array<string|int, mixed> $folder[, string|bool $previous = false ]) : mixed
Parameters
- $folder : array<string|int, mixed>
-
The folder data.
- $previous : string|bool = false
-
The previous default folder or false if there was none.
Return values
mixed —synchronize()
Synchronize the query data with the information from the backend.
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.