Abstract Class Horde_Kolab_Storage_Namespace_Element

Description
Direct descendents
Variable Summary
 string $_delimiter
 string $_name
Method Summary
 Horde_Kolab_Storage_Namespace_Element __construct (string $name, string $delimiter)
 string generateName (array $path)
 string getName ()
 string getOwner (string $name)
 string getSubpath (string $name)
 string getTitle (string $name)
 string getType ()
 boolean matches (string $name)
 array _subpath (string $name)
Variables
string $_delimiter (line 17)

The delimiter used for this namespace.

  • access: protected
string $_name (line 10)

The prefix identifying this namespace.

  • access: protected
Methods
Constructor __construct (line 25)

Constructor.

  • access: public
Horde_Kolab_Storage_Namespace_Element __construct (string $name, string $delimiter)
  • string $name: The prefix identifying this namespace.
  • string $delimiter: The delimiter used for this namespace.

Redefined in descendants as:
generateName (line 120)

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

  • return: The name of the folder.
  • access: public
string generateName (array $path)
  • array $path: The path of the folder.
getName (line 46)

Return the name of this namespace.

  • return: The name/prefix.
  • access: public
string getName ()
getOwner (line 70)

Return the owner of a folder.

  • return: The owner of the folder.
  • abstract:
  • access: public
string getOwner (string $name)
  • string $name: The name of the folder.

Redefined in descendants as:
getSubpath (line 91)

Get the sub path for the given folder name.

  • return: The sub path.
  • access: public
string getSubpath (string $name)
  • string $name: The folder name.
getTitle (line 79)

Return the title of a folder.

  • return: The title of the folder.
  • access: public
string getTitle (string $name)
  • string $name: The name of the folder.
getType (line 39)

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

  • return: The type.
  • abstract:
  • access: public
string getType ()

Redefined in descendants as:
matches (line 58)

Does the folder name lie in this namespace?

  • return: True if the folder is element of this namespace.
  • access: public
boolean matches (string $name)
  • string $name: The name of the folder.
_subpath (line 103)

Return an array describing the path elements of the folder.

  • return: The path elements.
  • access: protected
array _subpath (string $name)
  • string $name: The name of the folder.

Redefined in descendants as:

Documentation generated on Sun, 30 Jan 2011 05:17:05 +0000 by phpDocumentor 1.4.3