• Home
  • Horde_Kolab_Storage_List_Query_List_Cache_Synchronization

PHP Class Horde_Kolab_Storage_List_Query_List_Cache_Synchronization, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Kolab_Storage
Author: Gunnar Wrobel ([email protected])
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Folder_Types $types, Horde_Kolab_Storage_List_Query_List_Defaults $defaults ) Constructor.
_synchronize ( Horde_Kolab_Storage_Folder_Namespace $namespace, array $folder_list, $annotations ) : null Synchronize based on the given folder list.
getDuplicateDefaults ( ) : array Return any default folder duplicates.
setCache ( Horde_Kolab_Storage_List_Cache $cache ) Set the list cache.
setDefault ( array $folder, string | boolean $previous = false ) Set the specified folder as default for its current type.
synchronize ( ) Synchronize the query data with the information from the backend.
updateAfterCreateFolder ( string $folder, string $type = null ) : null Update the listener after creating a new folder.
updateAfterDeleteFolder ( string $folder ) : null Update the listener after deleting folder.
updateAfterRenameFolder ( string $old, string $new ) : null Update the listener after renaming a folder.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Folder_Types $types, Horde_Kolab_Storage_List_Query_List_Defaults $defaults )
$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

_synchronize() public method

Synchronize based on the given folder list.
public _synchronize ( Horde_Kolab_Storage_Folder_Namespace $namespace, array $folder_list, $annotations ) : null
$namespace Horde_Kolab_Storage_Folder_Namespace The namespace handler
$folder_list array The list of folders.
return null

getDuplicateDefaults() public method

Return any default folder duplicates.
public getDuplicateDefaults ( ) : array
return array The list of duplicate default folders accessible to the current user.

setCache() public method

Set the list cache.
public setCache ( Horde_Kolab_Storage_List_Cache $cache )
$cache Horde_Kolab_Storage_List_Cache The reference to the cache that should reveive any updates.

setDefault() public method

Set the specified folder as default for its current type.
public setDefault ( array $folder, string | boolean $previous = false )
$folder array The folder data.
$previous string | boolean The previous default folder or false if there was none.

synchronize() public method

Synchronize the query data with the information from the backend.
public synchronize ( )

updateAfterCreateFolder() public method

Update the listener after creating a new folder.
public updateAfterCreateFolder ( string $folder, string $type = null ) : null
$folder string The path of the folder that has been created.
$type string An optional type for the folder.
return null

updateAfterDeleteFolder() public method

Update the listener after deleting folder.
public updateAfterDeleteFolder ( string $folder ) : null
$folder string The path of the folder that has been deleted.
return null

updateAfterRenameFolder() public method

Update the listener after renaming a folder.
public updateAfterRenameFolder ( string $old, string $new ) : null
$old string The old path of the folder.
$new string The new path of the folder.
return null