Class Horde_Kolab_Storage_Folder_Namespace_Element

The Horde_Kolab_Storage_Folder_Namespace_Element:: class represents a namespace type.

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

Direct known subclasses

Horde_Kolab_Storage_Folder_Namespace_Element_Other, Horde_Kolab_Storage_Folder_Namespace_Element_Personal, Horde_Kolab_Storage_Folder_Namespace_Element_Shared

Indirect known subclasses

Horde_Kolab_Storage_Folder_Namespace_Element_SharedWithPrefix

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/Element.php

Methods summary
`public`	# `__construct( string $name, string $delimiter, string $user )` Constructor. Constructor. Parameters `$name` The prefix identifying this namespace. `$delimiter` The delimiter used for this namespace. `$user` The current user.
`abstract public string`	# `getType( )` Return the type of this namespace (personal, other, or shared). Return the type of this namespace (personal, other, or shared). Returns `string` The type.
`public string`	# `getName( )` Return the name of this namespace. Return the name of this namespace. Returns `string` The name/prefix.
`public string`	# `getDelimiter( )` Return the delimiter for this namespace. Return the delimiter for this namespace. Returns `string` The delimiter.
`public boolean`	# `matches( string $name )` Does the folder name lie in this namespace? Does the folder name lie in this namespace? Parameters `$name` The name of the folder. Returns `boolean` True if the folder is element of this namespace.
`abstract public string\|boolean`	# `getOwner( string $name )` Return the owner of a folder. Return the owner of a folder. Parameters `$name` The name of the folder. Returns `string\|boolean` The owner of the folder.
`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`	# `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`	# `generateName( array $path )` Generate a folder path for the given path in this namespace. Generate a folder path for the given path in this namespace. Parameters `$path` The path of the folder. Returns `string` The name of the folder.
`public string`	# `generatePath( string $subpath, string $owner )` Generate a folder path for the given subpath and owner. Generate a folder path for the given subpath and owner. Parameters `$subpath` The subpath of the folder. `$owner` The folder owner. Returns `string` The name of the folder. Since Horde_Kolab_Storage 1.1.0
`public string`	# `__toString( )` Convert the namespace description to a string. Convert the namespace description to a string. Returns `string` The namespace description.

Packages

Classes

Interfaces

Class Horde_Kolab_Storage_Folder_Namespace_Element

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Since

Returns