PHP Class Horde_Kolab_Storage_Folder_Namespace, horde

See link: http://pear.horde.org/index.php?package=Kolab_Storage

Author: Gunnar Wrobel ([email protected])

Inheritance: implements IteratorAggregate, implements Serializable

Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство	Type	Description
$user	string	The current user.

Méthodes publiques

Méthode	Description
__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.

Méthodes protégées

Méthode	Description
initialize ( array $namespaces ) : null	Initialize the class with a set of namespace configurations.

Private Methods

Méthode	Description
_getNamespace ( string $type, string $prefix = null ) : Horde_Kolab_Storage_Folder_Namespace_Element	Get the namespace matching the given type and (optional) prefix.

Method Details

__construct() public méthode

Constructor.

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

__toString() public méthode

Convert the namespace description to a string.

public __toString ( ) : string
Résultat	string	The namespace description.

constructFolderName() public méthode

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.
Résultat	string	The folder name for the backend.

getIterator() public méthode

public getIterator ( )

getOwner() public méthode

Return the owner of a folder.

public getOwner ( string $name ) : string
$name	string	The name of the folder.
Résultat	string	The owner of the folder.

getParent() public méthode

Get the parent for the given folder name.

public getParent ( string $name ) : string
$name	string	The parent folder name.
Résultat	string	The parent.

getSubpath() public méthode

Get the sub path for the given folder name.

public getSubpath ( string $name ) : string
$name	string	The folder name.
Résultat	string	The sub path.

getTitle() public méthode

Return the title of a folder.

public getTitle ( string $name ) : string
$name	string	The name of the folder.
Résultat	string	The title of the folder.

initialize() protected méthode

Initialize the class with a set of namespace configurations.

protected initialize ( array $namespaces ) : null
$namespaces	array	The namespaces.
Résultat	null

matchNamespace() public méthode

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.
Résultat	Horde_Kolab_Storage_Folder_Namespace_Element	The corresponding namespace.

setTitle() public méthode

Generate an IMAP folder name in the personal namespace.

public setTitle ( string $title ) : string
$title	string	The new folder title.
Résultat	string	The IMAP folder name.

setTitleInOther() public méthode

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.
Résultat	string	The IMAP folder name.

setTitleInShared() public méthode

Generate an IMAP folder name in the shared namespace.

public setTitleInShared ( string $title ) : string
$title	string	The new folder title.
Résultat	string	The IMAP folder name.

Property Details

$user protected_oe property

The current user.

protected string $user
Résultat	string