PHP Interface Horde_Kolab_Storage_Folder, 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.
Author: Stuart Binge ([email protected])
Author: Gunnar Wrobel ([email protected])
Author: Thomas Jarosch ([email protected])
Show file Open project: horde/horde Interface Usage Examples

Public Methods

Method Description
getNamespace ( ) : string Return the namespace type of the folder.
getOwner ( ) : string Returns the owner of the folder.
getParent ( ) : string Returns the folder parent.
getPath ( ) : string Return the storage path of the folder.
getPrefix ( ) : string Return the namespace prefix of the folder.
getSubpath ( ) : string Returns the folder path without namespace components.
getTitle ( ) : string Returns a readable title for this folder.
getType ( ) : string The type of this folder.
isDefault ( ) : boolean Is this a default folder?

Method Details

getNamespace() public method

Return the namespace type of the folder.
public getNamespace ( ) : string
return string The namespace type of the folder.

getOwner() public method

Returns the owner of the folder.
public getOwner ( ) : string
return string The owner of this folder.

getParent() public method

Returns the folder parent.
public getParent ( ) : string
return string The parent of this folder.

getPath() public method

Return the storage path of the folder.
public getPath ( ) : string
return string The storage path of the folder.

getPrefix() public method

Return the namespace prefix of the folder.
public getPrefix ( ) : string
return string The namespace prefix of the folder.

getSubpath() public method

Returns the folder path without namespace components.
public getSubpath ( ) : string
return string The subpath of this folder.

getTitle() public method

Returns a readable title for this folder.
public getTitle ( ) : string
return string The folder title.

getType() public method

The type of this folder.
public getType ( ) : string
return string The folder type.

isDefault() public method

Is this a default folder?
public isDefault ( ) : boolean
return boolean Boolean that indicates the default status.