Abstract Class Horde_Kolab_Storage_Namespace

Description

The Horde_Kolab_Storage_Namespace:: class handles IMAP namespaces and allows to derive folder information from folder names.

Copyright 2004-2010 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Storage/lib/Horde/Kolab/Storage/Namespace.php (line 30)


	
			
Direct descendents
Class Description
 class Horde_Kolab_Storage_Namespace_Config The Horde_Kolab_Storage_Namespace_Config:: allows to configure the available IMAP namespaces on the Kolab server.
 class Horde_Kolab_Storage_Namespace_Fixed The Horde_Kolab_Storage_Namespace_Fixed:: implements the default IMAP namespaces on the Kolab server.
Class Constant Summary
 OTHER = 'other'
 PERSONAL = 'personal'
 SHARED = 'shared'
Variable Summary
Method Summary
 Horde_Kolab_Storage_Namespace __construct ()
 string getCharset ()
 string getOwner (string $name)
 string getSubpath (string $name)
 string getTitle (string $name)
 string setName (string $name)
Variables

The namespace that matches any folder name not matching to another namespace.

  • access: protected
string $_charset (line 49)

The characterset this module uses to communicate with the outside world.

  • access: protected
array $_namespaces = array() (line 42)

The namespaces.

  • access: protected
Horde_Kolab_Storage_Namespace_Element $_primaryPersonalNamespace (line 72)

Indicates the personal namespace that the class will use to create new folders.

  • access: protected

Redefined in descendants as:
string $_sharedPrefix (line 56)

A prefix in the shared namespaces that will be ignored/removed.

  • access: protected
Methods
Constructor __construct (line 77)

Constructor.

  • access: public
Horde_Kolab_Storage_Namespace __construct ()

Redefined in descendants as:
getCharset (line 125)

Get the character set used/expected when calling the getTitle() or setName() methods.

  • return: The character set.
  • access: public
string getCharset ()
getOwner (line 150)

Return the owner of a folder.

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

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 137)

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.
matchNamespace (line 107)

Match a folder name with the corresponding namespace.

  • return: The corresponding namespace.
  • throws: Horde_Kolab_Storage_Exception If the namespace of the folder cannot be determined.
  • access: public
Horde_Kolab_Storage_Namespace_Element matchNamespace (string $name)
  • string $name: The name of the folder.
setName (line 176)

Generate an IMAP folder name.

  • return: The IMAP folder name.
  • access: public
string setName (string $name)
  • string $name: The new folder name.
Class Constants
OTHER = 'other' (line 34)
PERSONAL = 'personal' (line 33)

The possible namespace types (RFC 2342 [5])

SHARED = 'shared' (line 35)

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