Horde_Kolab_Storage_List_Manipulation_Base
extends Horde_Kolab_Storage_List_Manipulation
in package
Handles all manipulations of a Horde_Kolab_Storage_List.
Copyright 2004-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
- $_driver : Horde_Kolab_Storage_Driver
- The driver for accessing the Kolab storage system.
- $_listeners : array<string|int, Horde_Kolab_Storage_List_Manipulation_Listener>
- The list of registered queries.
- __construct() : mixed
- Constructor.
- createFolder() : null
- Create a new folder.
- deleteFolder() : null
- Delete a folder.
- registerListener() : mixed
- Register a new manipulation listener.
- renameFolder() : null
- Rename a folder.
Properties
$_driver
The driver for accessing the Kolab storage system.
private
Horde_Kolab_Storage_Driver
$_driver
$_listeners
The list of registered queries.
private
array<string|int, Horde_Kolab_Storage_List_Manipulation_Listener>
$_listeners
= array()
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Driver $driver) : mixed
Parameters
- $driver : Horde_Kolab_Storage_Driver
-
The primary connection driver.
Return values
mixed —createFolder()
Create a new folder.
public
createFolder(string $folder[, string $type = null ]) : null
Parameters
- $folder : string
-
The path of the folder to create.
- $type : string = null
-
An optional type for the folder.
Return values
null —deleteFolder()
Delete a folder.
public
deleteFolder(string $folder) : null
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.
Parameters
- $folder : string
-
The path of the folder to delete.
Return values
null —registerListener()
Register a new manipulation listener.
public
registerListener(Horde_Kolab_Storage_List_Manipulation_Listener $listener) : mixed
Parameters
- $listener : Horde_Kolab_Storage_List_Manipulation_Listener
-
The new listener.
Return values
mixed —renameFolder()
Rename a folder.
public
renameFolder(string $old, string $new) : null
Parameters
- $old : string
-
The old path of the folder.
- $new : string
-
The new path of the folder.