PHP Class Horde_Kolab_Storage_List_Query_Share_Cache, horde

Copyright 2011-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])
Inheritance: extends Horde_Kolab_Storage_List_Query_Share, implements Horde_Kolab_Storage_List_Manipulation_Listener, implements Horde_Kolab_Storage_List_Synchronization_Listener
Exibir arquivo Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_List_Query_Share $query, Horde_Kolab_Storage_List_Cache $cache ) Constructor.
getDescription ( string $folder ) : string Returns the share description.
getParameters ( string $folder ) : string Returns the share parameters.
setDescription ( string $folder, string $description ) : string Returns the share description.
setParameters ( string $folder, array $parameters ) : string Returns the share parameters.
synchronize ( array $params = [] ) : null Synchronize the ACL information 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_List_Query_Share $query, Horde_Kolab_Storage_List_Cache $cache )
$query Horde_Kolab_Storage_List_Query_Share The underlying share query.
$cache Horde_Kolab_Storage_List_Cache The list cache.

getDescription() public method

Returns the share description.
public getDescription ( string $folder ) : string
$folder string The folder name.
return string The folder/share description.

getParameters() public method

Returns the share parameters.
public getParameters ( string $folder ) : string
$folder string The folder name.
return string The folder/share parameters.

setDescription() public method

Returns the share description.
public setDescription ( string $folder, string $description ) : string
$folder string The folder name.
$description string The share description.
return string The folder/share description.

setParameters() public method

Returns the share parameters.
public setParameters ( string $folder, array $parameters ) : string
$folder string The folder name.
$parameters array The share parameters.
return string The folder/share parameters.

synchronize() public method

Synchronize the ACL information with the information from the backend.
public synchronize ( array $params = [] ) : null
$params array Additional parameters.
return null

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