• Home
  • Horde_Kolab_Storage_List_Manipulation_Base

PHP Class Horde_Kolab_Storage_List_Manipulation_Base, horde

Copyright 2004-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_Manipulation
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Driver $driver ) Constructor.
createFolder ( string $folder, string $type = null ) : null Create a new folder.
deleteFolder ( string $folder ) : null Delete a folder.
registerListener ( Horde_Kolab_Storage_List_Manipulation_Listener $listener ) Register a new manipulation listener.
renameFolder ( string $old, string $new ) : null Rename a folder.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Driver $driver )
$driver Horde_Kolab_Storage_Driver The primary connection driver.

createFolder() public method

Create a new folder.
public createFolder ( string $folder, string $type = null ) : null
$folder string The path of the folder to create.
$type string An optional type for the folder.
return null

deleteFolder() public method

WARNING: Do not use this call in case there is still data present in the folder. You are required to empty any data set *before* removing the folder. Otherwise there is no guarantee you can adhere to that Kolab specification that might require the triggering of remote systems to inform them about the removal of the folder.
public deleteFolder ( string $folder ) : null
$folder string The path of the folder to delete.
return null

registerListener() public method

Register a new manipulation listener.
public registerListener ( Horde_Kolab_Storage_List_Manipulation_Listener $listener )
$listener Horde_Kolab_Storage_List_Manipulation_Listener The new listener.

renameFolder() public method

Rename a folder.
public renameFolder ( string $old, string $new ) : null
$old string The old path of the folder.
$new string The new path of the folder.
return null