Class Horde_Kolab_Storage_Folder_Namespace

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

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Kolab_Storage_Folder_Namespace implements Iterator, Serializable

Direct known subclasses

Horde_Kolab_Storage_Folder_Namespace_Config, Horde_Kolab_Storage_Folder_Namespace_Fixed

Indirect known subclasses

Horde_Kolab_Storage_Folder_Namespace_Imap

Abstract
Package: Kolab\Storage
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/Folder/Namespace.php

Methods summary
`public`	# `__construct( array $namespaces )` Constructor. Constructor. Parameters `$namespaces` The namespaces.
`public Horde_Kolab_Storage_Folder_Namespace_Element`	# `matchNamespace( string $name )` Match a folder name with the corresponding namespace. Match a folder name with the corresponding namespace. Parameters `$name` The name of the folder. Returns `Horde_Kolab_Storage_Folder_Namespace_Element` The corresponding namespace. Throws `Horde_Kolab_Storage_Exception` If the namespace of the folder cannot be determined.
`public string`	# `getOwner( string $name )` Return the owner of a folder. Return the owner of a folder. Parameters `$name` The name of the folder. Returns `string` The owner of the folder.
`public string`	# `getSubpath( string $name )` Get the sub path for the given folder name. Get the sub path for the given folder name. Parameters `$name` The folder name. Returns `string` The sub path.
`public string`	# `getParent( string $name )` Get the parent for the given folder name. Get the parent for the given folder name. Parameters `$name` The parent folder name. Returns `string` The parent.
`public string`	# `getTitle( string $name )` Return the title of a folder. Return the title of a folder. Parameters `$name` The name of the folder. Returns `string` The title of the folder.
`public string`	# `constructFolderName( string $owner, string $subpath, string $prefix = null )` Construct the Kolab storage folder name based on the folder title and the owner. Construct the Kolab storage folder name based on the folder title and the owner. Parameters `$owner` The owner of the folder. `$subpath` The folder subpath. `$prefix` The namespace prefix. Returns `string` The folder name for the backend.
`public string`	# `setTitle( string $title )` Generate an IMAP folder name in the personal namespace. Generate an IMAP folder name in the personal namespace. Parameters `$title` The new folder title. Returns `string` The IMAP folder name.
`public string`	# `setTitleInOther( string $title, string $owner )` Generate an IMAP folder name in the other namespace. Generate an IMAP folder name in the other namespace. Parameters `$title` The new folder title. `$owner` The new owner of the folder. Returns `string` The IMAP folder name.
`public string`	# `setTitleInShared( string $title )` Generate an IMAP folder name in the shared namespace. Generate an IMAP folder name in the shared namespace. Parameters `$title` The new folder title. Returns `string` The IMAP folder name.
`public`	# `rewind( )` Implementation of the Iterator rewind() method. Rewinds the namespace list. Implementation of the Iterator rewind() method. Rewinds the namespace list. return NULL Implementation of `Iterator::rewind()`
`public Horde_Kolab_Storage_Folder_Namespace_Element\|null`	# `current( )` Implementation of the Iterator current(). Returns the current namespace. Implementation of the Iterator current(). Returns the current namespace. Returns `Horde_Kolab_Storage_Folder_Namespace_Element\|null` The current namespace. Implementation of `Iterator::current()`
`public mixed`	# `key( )` Implementation of the Iterator key() method. Returns the key of the current namespace. Implementation of the Iterator key() method. Returns the key of the current namespace. Returns `mixed` The key for the current position. Implementation of `Iterator::key()`
`public Horde_Kolab_Storage_Folder_Namespace_Element\|null`	# `next( )` Implementation of the Iterator next() method. Returns the next namespace. Implementation of the Iterator next() method. Returns the next namespace. Returns `Horde_Kolab_Storage_Folder_Namespace_Element\|null` The next namespace or null if there are no more namespaces. Implementation of `Iterator::next()`
`public boolean`	# `valid( )` Implementation of the Iterator valid() method. Indicates if the current element is a valid element. Implementation of the Iterator valid() method. Indicates if the current element is a valid element. Returns `boolean` Whether the current element is valid Implementation of `Iterator::valid()`
`public string`	# `__toString( )` Convert the namespace description to a string. Convert the namespace description to a string. Returns `string` The namespace description.

Methods inherited from Serializable
`serialize(), unserialize()`

Constants summary
`string`	`PERSONAL` The possible namespace types (RFC 2342 [5]) The possible namespace types (RFC 2342 [5])	# `'personal'`
`string`	`OTHER`	# `'other'`
`string`	`SHARED`	# `'shared'`

Packages

Classes

Interfaces

Class Horde_Kolab_Storage_Folder_Namespace

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns