API Documentation
\

\Horde_Kolab_Storage_Folder

The interface describing a Kolab folder.

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.

Summary

Methods
Constants
getPath()
getTitle()
getNamespace()
getPrefix()
getOwner()
getSubpath()
getParent()
isDefault()
getType()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getPath()

getPath() : string

Return the storage path of the folder.

Returns

string —

The storage path of the folder.

getTitle()

getTitle() : string

Returns a readable title for this folder.

Returns

string —

The folder title.

getNamespace()

getNamespace() : string

Return the namespace type of the folder.

Returns

string —

The namespace type of the folder.

getPrefix()

getPrefix() : string

Return the namespace prefix of the folder.

Returns

string —

The namespace prefix of the folder.

getOwner()

getOwner() : string

Returns the owner of the folder.

Returns

string —

The owner of this folder.

getSubpath()

getSubpath() : string

Returns the folder path without namespace components.

Returns

string —

The subpath of this folder.

getParent()

getParent() : string

Returns the folder parent.

Returns

string —

The parent of this folder.

isDefault()

isDefault() : boolean

Is this a default folder?

Returns

boolean —

Boolean that indicates the default status.

getType()

getType() : string

The type of this folder.

Returns

string —

The folder type.