PHP Класс Horde_Kolab_Storage_Folder_Namespace, horde

Copyright 2004-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
См. ссылку: http://pear.horde.org/index.php?package=Kolab_Storage
Автор: Gunnar Wrobel ([email protected])
Наследование: implements IteratorAggregate, implements Serializable
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$user string The current user.

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

Метод Описание
__construct ( array $namespaces ) Constructor.
__toString ( ) : string Convert the namespace description to a string.
constructFolderName ( string $owner, string $subpath, string $prefix = null ) : string Construct the Kolab storage folder name based on the folder title and the owner.
getIterator ( )
getOwner ( string $name ) : string 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.
matchNamespace ( string $name ) : Horde_Kolab_Storage_Folder_Namespace_Element Match a folder name with the corresponding namespace.
setTitle ( string $title ) : string Generate an IMAP folder name in the personal namespace.
setTitleInOther ( string $title, string $owner ) : string Generate an IMAP folder name in the other namespace.
setTitleInShared ( string $title ) : string Generate an IMAP folder name in the shared namespace.

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

Метод Описание
initialize ( array $namespaces ) : null Initialize the class with a set of namespace configurations.

Приватные методы

Метод Описание
_getNamespace ( string $type, string $prefix = null ) : Horde_Kolab_Storage_Folder_Namespace_Element Get the namespace matching the given type and (optional) prefix.

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

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

Constructor.
public __construct ( array $namespaces )
$namespaces array The namespaces.

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

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

constructFolderName() публичный метод

Construct the Kolab storage folder name based on the folder title and the owner.
public constructFolderName ( string $owner, string $subpath, string $prefix = null ) : string
$owner string The owner of the folder.
$subpath string The folder subpath.
$prefix string The namespace prefix.
Результат string The folder name for the backend.

getIterator() публичный метод

public getIterator ( )

getOwner() публичный метод

Return the owner of a folder.
public getOwner ( string $name ) : string
$name string The name of the folder.
Результат string 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.

initialize() защищенный метод

Initialize the class with a set of namespace configurations.
protected initialize ( array $namespaces ) : null
$namespaces array The namespaces.
Результат null

matchNamespace() публичный метод

Match a folder name with the corresponding namespace.
public matchNamespace ( string $name ) : Horde_Kolab_Storage_Folder_Namespace_Element
$name string The name of the folder.
Результат Horde_Kolab_Storage_Folder_Namespace_Element The corresponding namespace.

setTitle() публичный метод

Generate an IMAP folder name in the personal namespace.
public setTitle ( string $title ) : string
$title string The new folder title.
Результат string The IMAP folder name.

setTitleInOther() публичный метод

Generate an IMAP folder name in the other namespace.
public setTitleInOther ( string $title, string $owner ) : string
$title string The new folder title.
$owner string The new owner of the folder.
Результат string The IMAP folder name.

setTitleInShared() публичный метод

Generate an IMAP folder name in the shared namespace.
public setTitleInShared ( string $title ) : string
$title string The new folder title.
Результат string The IMAP folder name.

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

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

The current user.
protected string $user
Результат string