PHP Класс Horde_Kolab_Storage_Folder_Namespace_Element, horde

См. ссылку: http://pear.horde.org/index.php?package=Kolab_Storage

Автор: Gunnar Wrobel ([email protected])

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_delimiter	string	The delimiter used for this namespace.
$_name	string	The prefix identifying this namespace.
$_user	string	The current user.

Открытые методы

Метод	Описание
__construct ( string $name, string $delimiter, string $user )	Constructor.
__toString ( ) : string	Convert the namespace description to a string.
generateName ( array $path ) : string	Generate a folder path for the given path in this namespace.
generatePath ( string $subpath, string $owner ) : 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 $name ) : string \| boolean	Return the owner of a folder.
getParent ( string $name ) : string	Get the parent for the given folder name.
getSubpath ( string $name ) : string	Get the sub path for the given folder name.
getTitle ( string $name ) : string	Return the title of a folder.
getType ( ) : string	Return the type of this namespace (personal, other, or shared).
matches ( string $name ) : boolean	Does the folder name lie in this namespace?

Защищенные методы

Метод	Описание
_subpath ( string $name ) : array	Return an array describing the path elements of the folder.

Описание методов

__construct() публичный Метод

Constructor.

public __construct ( string $name, string $delimiter, string $user )
$name	string	The prefix identifying this namespace.
$delimiter	string	The delimiter used for this namespace.
$user	string	The current user.

__toString() публичный Метод

Convert the namespace description to a string.

public __toString ( ) : string
Результат	string	The namespace description.

_subpath() защищенный Метод

Return an array describing the path elements of the folder.

protected _subpath ( string $name ) : array
$name	string	The name of the folder.
Результат	array	The path elements.

generateName() публичный Метод

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

public generateName ( array $path ) : string
$path	array	The path of the folder.
Результат	string	The name of the folder.

generatePath() публичный Метод

Generate a folder path for the given subpath and owner.

public generatePath ( string $subpath, string $owner ) : string
$subpath	string	The subpath of the folder.
$owner	string	The folder owner.
Результат	string	The name of the folder.

getDelimiter() публичный Метод

Return the delimiter for this namespace.

public getDelimiter ( ) : string
Результат	string	The delimiter.

getName() публичный Метод

Return the name of this namespace.

public getName ( ) : string
Результат	string	The name/prefix.

getOwner() абстрактный публичный Метод

Return the owner of a folder.

abstract public getOwner ( string $name ) : string \| boolean
$name	string	The name of the folder.
Результат	string \| boolean	The owner of the folder.

getParent() публичный Метод

Get the parent for the given folder name.

public getParent ( string $name ) : string
$name	string	The parent folder name.
Результат	string	The parent.

getSubpath() публичный Метод

Get the sub path for the given folder name.

public getSubpath ( string $name ) : string
$name	string	The folder name.
Результат	string	The sub path.

getTitle() публичный Метод

Return the title of a folder.

public getTitle ( string $name ) : string
$name	string	The name of the folder.
Результат	string	The title of the folder.

getType() абстрактный публичный Метод

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

abstract public getType ( ) : string
Результат	string	The type.

matches() публичный Метод

Does the folder name lie in this namespace?

public matches ( string $name ) : boolean
$name	string	The name of the folder.
Результат	boolean	True if the folder is element of this namespace.

Описание свойств

$_delimiter защищенное свойство

The delimiter used for this namespace.

protected string $_delimiter
Результат	string

$_name защищенное свойство

The prefix identifying this namespace.

protected string $_name
Результат	string

$_user защищенное свойство

The current user.

protected string $_user
Результат	string