API Documentation
\

\Horde_Kolab_Storage_List_Query_List_Cache_Synchronization

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.

Summary

Methods
Properties
Constants
__construct()
setCache()
synchronize()
_synchronize()
updateAfterCreateFolder()
updateAfterDeleteFolder()
updateAfterRenameFolder()
setDefault()
getDuplicateDefaults()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_driver
$_folder_types
$_defaults
$_cache
N/A

Properties

Methods

setCache()

setCache(\Horde_Kolab_Storage_List_Cache  $cache)

Set the list cache.

Parameters

\Horde_Kolab_Storage_List_Cache $cache

The reference to the cache that should reveive any updates.

synchronize()

synchronize()

Synchronize the query data with the information from the backend.

_synchronize()

_synchronize(\Horde_Kolab_Storage_Folder_Namespace  $namespace, array  $folder_list,   $annotations) : NULL

Synchronize based on the given folder list.

Parameters

\Horde_Kolab_Storage_Folder_Namespace $namespace

The namespace handler
array $folder_list

The list of folders.
$annotations

Returns

NULL

updateAfterCreateFolder()

updateAfterCreateFolder(string  $folder, string  $type = null) : NULL

Update the listener after creating a new folder.

Parameters

string $folder

The path of the folder that has been created.
string $type

An optional type for the folder.

Returns

NULL

updateAfterDeleteFolder()

updateAfterDeleteFolder(string  $folder) : NULL

Update the listener after deleting folder.

Parameters

string $folder

The path of the folder that has been deleted.

Returns

NULL

updateAfterRenameFolder()

updateAfterRenameFolder(string  $old, string  $new) : NULL

Update the listener after renaming a folder.

Parameters

string $old

The old path of the folder.
string $new

The new path of the folder.

Returns

NULL

setDefault()

setDefault(array  $folder, string|boolean  $previous = false)

Set the specified folder as default for its current type.

Parameters

array $folder

The folder data.
string|boolean $previous

The previous default folder or false if there was none.

getDuplicateDefaults()

getDuplicateDefaults() : array

Return any default folder duplicates.

Returns

array —

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