\Horde_Kolab_Storage_Folder_Namespace_Element_Shared

The Horde_Kolab_Storage_Folder_Namespace_Element_Shared:: class represents the shared namespace.

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.

Summary

Methods
Properties
Constants
__construct()
getType()
getName()
getDelimiter()
matches()
getOwner()
getTitle()
getSubpath()
getParent()
generateName()
generatePath()
__toString()
No public properties found
No constants found
_subpath()
$_name
$_delimiter
$_user
N/A
No private methods found
No private properties found
N/A

Properties

$_name

$_name : string

The prefix identifying this namespace.

Type

string

$_delimiter

$_delimiter : string

The delimiter used for this namespace.

Type

string

$_user

$_user : string

The current user.

Type

string

Methods

__construct()

__construct(string  $name, string  $delimiter, string  $user) 

Constructor.

Parameters

string $name

The prefix identifying this namespace.

string $delimiter

The delimiter used for this namespace.

string $user

The current user.

getType()

getType() : string

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

Returns

string —

The type.

getName()

getName() : string

Return the name of this namespace.

Returns

string —

The name/prefix.

getDelimiter()

getDelimiter() : string

Return the delimiter for this namespace.

Returns

string —

The delimiter.

matches()

matches(string  $name) : boolean

Does the folder name lie in this namespace?

Parameters

string $name

The name of the folder.

Returns

boolean —

True if the folder is element of this namespace.

getOwner()

getOwner(string  $name) : string|boolean

Return the owner of a folder.

Parameters

string $name

The name of the folder.

Returns

string|boolean —

The owner of the folder.

getTitle()

getTitle(string  $name) : string

Return the title of a folder.

Parameters

string $name

The name of the folder.

Returns

string —

The title of the folder.

getSubpath()

getSubpath(string  $name) : string

Get the sub path for the given folder name.

Parameters

string $name

The folder name.

Returns

string —

The sub path.

getParent()

getParent(string  $name) : string

Get the parent for the given folder name.

Parameters

string $name

The parent folder name.

Returns

string —

The parent.

generateName()

generateName(array  $path) : string

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

Parameters

array $path

The path of the folder.

Returns

string —

The name of the folder.

generatePath()

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

Generate a folder path for the given subpath and owner.

Parameters

string $subpath

The subpath of the folder.

string $owner

The folder owner.

Returns

string —

The name of the folder.

__toString()

__toString() : string

Convert the namespace description to a string.

Returns

string —

The namespace description.

_subpath()

_subpath(string  $name) : array

Return an array describing the path elements of the folder.

Parameters

string $name

The name of the folder.

Returns

array —

The path elements.