API Documentation
\

\Horde_Kolab_Storage_Folder_Base

The Kolab_Folder class represents an single folder in the Kolab backend.

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
Properties
Constants
__construct()
get()
getWithNull()
getPath()
getNamespace()
getPrefix()
getTitle()
getOwner()
getSubpath()
getParent()
isDefault()
getType()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_init()
$_list
$_path
$_data
N/A

Properties

$_list

$_list : \Horde_Kolab_Storage_List

The handler for the list of folders.

Type

\Horde_Kolab_Storage_List

$_path

$_path : string

The folder path.

Type

string

$_data

$_data : array

Additional folder information.

Type

array

Methods

__construct()

__construct(\Horde_Kolab_Storage_List_Query_List  $list, string  $path)

Constructor.

Parameters

\Horde_Kolab_Storage_List_Query_List $list

The query handler for the list of folders.
string $path

Path of the folder.

get()

get(string  $key) : mixed

Fetch a data value.

Parameters

string $key

The name of the data value to fetch.

Returns

mixed —

The data value

getWithNull()

getWithNull(string  $key) : mixed

Fetch a data value and accept a missing value (represented by the return value NULL).

Parameters

string $key

The name of the data value to fetch.

Returns

mixed —

The data value

getPath()

getPath() : string

Return the storage path of the folder.

Returns

string —

The storage path of the folder.

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.

getTitle()

getTitle() : string

Returns a readable title for this folder.

Returns

string —

The folder title.

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.

_init()

_init() : NULL

Fetch the data array.

Returns

NULL