PHP Class Horde_Kolab_Storage_Folder_Namespace_Element, horde

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

Author: Gunnar Wrobel ([email protected])

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

Protected Properties

Свойство	Type	Description
$_delimiter	string	The delimiter used for this namespace.
$_name	string	The prefix identifying this namespace.
$_user	string	The current user.

Méthodes publiques

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

Méthodes protégées

Méthode	Description
_subpath ( string $name ) : array	Return an array describing the path elements of the folder.

Method Details

__construct() public méthode

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() public méthode

Convert the namespace description to a string.

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

_subpath() protected méthode

Return an array describing the path elements of the folder.

protected _subpath ( string $name ) : array
$name	string	The name of the folder.
Résultat	array	The path elements.

generateName() public méthode

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

public generateName ( array $path ) : string
$path	array	The path of the folder.
Résultat	string	The name of the folder.

generatePath() public méthode

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

getDelimiter() public méthode

Return the delimiter for this namespace.

public getDelimiter ( ) : string
Résultat	string	The delimiter.

getName() public méthode

Return the name of this namespace.

public getName ( ) : string
Résultat	string	The name/prefix.

getOwner() abstract public méthode

Return the owner of a folder.

abstract public getOwner ( string $name ) : string \| boolean
$name	string	The name of the folder.
Résultat	string \| boolean	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.

getType() abstract public méthode

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

abstract public getType ( ) : string
Résultat	string	The type.

matches() public méthode

Does the folder name lie in this namespace?

public matches ( string $name ) : boolean
$name	string	The name of the folder.
Résultat	boolean	True if the folder is element of this namespace.

Property Details

$_delimiter protected_oe property

The delimiter used for this namespace.

protected string $_delimiter
Résultat	string

$_name protected_oe property

The prefix identifying this namespace.

protected string $_name
Résultat	string

$_user protected_oe property

The current user.

protected string $_user
Résultat	string