Documentation

Horde_Kolab_Storage_List_Manipulation
in package

Describes Kolab folder list manipulators.

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
category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

createFolder()  : null
Create a new folder.
deleteFolder()  : null
Delete a folder.
registerListener()  : mixed
Register a new manipulation listener.
renameFolder()  : null
Rename a folder.

Methods

createFolder()

Create a new folder.

public abstract 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 abstract 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

renameFolder()

Rename a folder.

public abstract renameFolder(string $old, string $new) : null
Parameters
$old : string

The old path of the folder.

$new : string

The new path of the folder.

Return values
null

Search results