Documentation

Horde_Kolab_Storage_Folder_Namespace_Element_Personal extends Horde_Kolab_Storage_Folder_Namespace_Element
in package

The Horde_Kolab_Storage_Folder_Namespace_Element_Personal:: class represents the namespace for folders owned by the currently authenticated user.

Copyright 2010-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

$_delimiter  : string
The delimiter used for this namespace.
$_name  : string
The prefix identifying this namespace.
$_user  : string
The current user.
__construct()  : mixed
Constructor.
__toString()  : string
Convert the namespace description to a string.
generateName()  : string
Generate a folder path for the given path in this namespace.
generatePath()  : string
Generate a folder path for the given subpath and owner.
getDelimiter()  : string
Return the delimiter for this namespace.
getName()  : string
Return the name of this namespace.
getOwner()  : string|bool
Return the owner of a folder.
getParent()  : string
Get the parent for the given folder name.
getSubpath()  : string
Get the sub path for the given folder name.
getTitle()  : string
Return the title of a folder.
getType()  : string
Return the type of this namespace (personal, other, or shared).
matches()  : bool
Does the folder name lie in this namespace?
_subpath()  : array<string|int, mixed>
Return an array describing the path elements of the folder.

Properties

$_delimiter

The delimiter used for this namespace.

protected string $_delimiter

$_name

The prefix identifying this namespace.

protected string $_name

$_user

The current user.

protected string $_user

Methods

__construct()

Constructor.

public __construct(string $name, string $delimiter, string $user) : mixed
Parameters
$name : string

The prefix identifying this namespace.

$delimiter : string

The delimiter used for this namespace.

$user : string

The current user.

Return values
mixed —

__toString()

Convert the namespace description to a string.

public __toString() : string
Return values
string —

The namespace description.

generateName()

Generate a folder path for the given path in this namespace.

public generateName(array<string|int, mixed> $path) : string
Parameters
$path : array<string|int, mixed>

The path of the folder.

Return values
string —

The name of the folder.

generatePath()

Generate a folder path for the given subpath and owner.

public generatePath(string $subpath, string $owner) : string
Parameters
$subpath : string

The subpath of the folder.

$owner : string

The folder owner.

Return values
string —

The name of the folder.

getDelimiter()

Return the delimiter for this namespace.

public getDelimiter() : string
Return values
string —

The delimiter.

getName()

Return the name of this namespace.

public getName() : string
Return values
string —

The name/prefix.

getOwner()

Return the owner of a folder.

public getOwner(string $name) : string|bool
Parameters
$name : string

The name of the folder.

Return values
string|bool —

The owner of the folder.

getParent()

Get the parent for the given folder name.

public getParent(string $name) : string
Parameters
$name : string

The parent folder name.

Return values
string —

The parent.

getSubpath()

Get the sub path for the given folder name.

public getSubpath(string $name) : string
Parameters
$name : string

The folder name.

Return values
string —

The sub path.

getTitle()

Return the title of a folder.

public getTitle(string $name) : string
Parameters
$name : string

The name of the folder.

Return values
string —

The title of the folder.

getType()

Return the type of this namespace (personal, other, or shared).

public getType() : string
Return values
string —

The type.

matches()

Does the folder name lie in this namespace?

public matches(string $name) : bool
Parameters
$name : string

The name of the folder.

Return values
bool —

True if the folder is element of this namespace.

_subpath()

Return an array describing the path elements of the folder.

protected _subpath(string $name) : array<string|int, mixed>
Parameters
$name : string

The name of the folder.

Return values
array<string|int, mixed> —

The path elements.

Search results