Horde_Kolab_Storage_Folder_Base
in package
implements
Horde_Kolab_Storage_Folder
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.
Tags
Interfaces, Classes, Traits and Enums
- Horde_Kolab_Storage_Folder
- The interface describing a Kolab folder.
Table of Contents
- $_data : array<string|int, mixed>
- Additional folder information.
- $_list : Horde_Kolab_Storage_List
- The handler for the list of folders.
- $_path : string
- The folder path.
- __construct() : mixed
- Constructor.
- get() : mixed
- Fetch a data value.
- 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.
- getWithNull() : mixed
- Fetch a data value and accept a missing value (represented by the return value NULL).
- isDefault() : bool
- Is this a default folder?
- _init() : null
- Fetch the data array.
Properties
$_data
Additional folder information.
private
array<string|int, mixed>
$_data
$_list
The handler for the list of folders.
private
Horde_Kolab_Storage_List
$_list
$_path
The folder path.
private
string
$_path
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_List_Query_List $list, string $path) : mixed
Parameters
- $list : Horde_Kolab_Storage_List_Query_List
-
The query handler for the list of folders.
- $path : string
-
Path of the folder.
Return values
mixed —get()
Fetch a data value.
public
get(string $key) : mixed
Parameters
- $key : string
-
The name of the data value to fetch.
Return values
mixed —The data value
getNamespace()
Return the namespace type of the folder.
public
getNamespace() : string
Return values
string —The namespace type of the folder.
getOwner()
Returns the owner of the folder.
public
getOwner() : string
Return values
string —The owner of this folder.
getParent()
Returns the folder parent.
public
getParent() : string
Return values
string —The parent of this folder.
getPath()
Return the storage path of the folder.
public
getPath() : string
Return values
string —The storage path of the folder.
getPrefix()
Return the namespace prefix of the folder.
public
getPrefix() : string
Return values
string —The namespace prefix of the folder.
getSubpath()
Returns the folder path without namespace components.
public
getSubpath() : string
Return values
string —The subpath of this folder.
getTitle()
Returns a readable title for this folder.
public
getTitle() : string
Return values
string —The folder title.
getType()
The type of this folder.
public
getType() : string
Return values
string —The folder type.
getWithNull()
Fetch a data value and accept a missing value (represented by the return value NULL).
public
getWithNull(string $key) : mixed
Parameters
- $key : string
-
The name of the data value to fetch.
Return values
mixed —The data value
isDefault()
Is this a default folder?
public
isDefault() : bool
Return values
bool —Boolean that indicates the default status.
_init()
Fetch the data array.
private
_init() : null