Class Horde_Kolab_Storage_Folder_Base

The Kolab_Folder class represents an single folder in the Kolab backend.

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_Base implements Horde_Kolab_Storage_Folder

Package: Kolab\Storage
Author: Stuart Binge omicron@mighty.co.za
Author: Gunnar Wrobel wrobel@pardus.de
Author: Thomas Jarosch thomas.jarosch@intra2net.com
Located at Horde/Kolab/Storage/Folder/Base.php

Methods summary
`public`	# `__construct( Horde_Kolab_Storage_List $list, string $path )` Constructor. Constructor. Parameters `$list` <p>The handler for the list of folders.</p> `$path` Path of the folder.
`public mixed`	# `get( string $key )` Fetch a data value. Fetch a data value. Parameters `$key` The name of the data value to fetch. Returns `mixed` The data value
`public mixed`	# `getWithNull( string $key )` Fetch a data value and accept a missing value (represented by the return value NULL). Fetch a data value and accept a missing value (represented by the return value NULL). Parameters `$key` The name of the data value to fetch. Returns `mixed` The data value
`public string`	# `getPath( )` Return the storage path of the folder. Return the storage path of the folder. Returns `string` The storage path of the folder. Implementation of `Horde_Kolab_Storage_Folder::getPath()`
`public string`	# `getNamespace( )` Return the namespace type of the folder. Return the namespace type of the folder. Returns `string` The namespace type of the folder. Implementation of `Horde_Kolab_Storage_Folder::getNamespace()`
`public string`	# `getPrefix( )` Return the namespace prefix of the folder. Return the namespace prefix of the folder. Returns `string` The namespace prefix of the folder. Since Horde_Kolab_Storage 1.1.0 Implementation of `Horde_Kolab_Storage_Folder::getPrefix()`
`public string`	# `getTitle( )` Returns a readable title for this folder. Returns a readable title for this folder. Returns `string` The folder title. Implementation of `Horde_Kolab_Storage_Folder::getTitle()`
`public string`	# `getOwner( )` Returns the owner of the folder. Returns the owner of the folder. Returns `string` The owner of this folder. Implementation of `Horde_Kolab_Storage_Folder::getOwner()`
`public string`	# `getSubpath( )` Returns the folder path without namespace components. Returns the folder path without namespace components. Returns `string` The subpath of this folder. Implementation of `Horde_Kolab_Storage_Folder::getSubpath()`
`public string`	# `getParent( )` Returns the folder parent. Returns the folder parent. Returns `string` The parent of this folder. Implementation of `Horde_Kolab_Storage_Folder::getParent()`
`public boolean`	# `isDefault( )` Is this a default folder? Is this a default folder? Returns `boolean` Boolean that indicates the default status. Implementation of `Horde_Kolab_Storage_Folder::isDefault()`
`public string`	# `getType( )` The type of this folder. The type of this folder. Returns `string` The folder type.
`public null`	# `save( array $attributes = null )` Saves the folder. Saves the folder. Parameters `$attributes` <p>An array of folder attributes. You can set any attribute but there are a few special ones like 'type', 'default', 'owner' and 'desc'.</p> Returns `null` Implementation of `Horde_Kolab_Storage_Folder::save()`
`public boolean\|PEAR_Error`	# `delete( )` Delete this folder. Delete this folder. Returns `boolean\|PEAR_Error` True if the operation succeeded.
`public mixed`	# `getAttribute( string $attribute )` Returns one of the attributes of the folder, or an empty string if it isn't defined. Returns one of the attributes of the folder, or an empty string if it isn't defined. Parameters `$attribute` The attribute to retrieve. Returns `mixed` The value of the attribute, an empty string or an error.
`public mixed`	# `getKolabAttribute( string $attribute )` Returns one of the Kolab attributes of the folder, or an empty string if it isn't defined. Returns one of the Kolab attributes of the folder, or an empty string if it isn't defined. Parameters `$attribute` The attribute to retrieve. Returns `mixed` The value of the attribute, an empty string or an error.
`public boolean\|PEAR_Error`	# `exists( )` Returns whether the folder exists. Returns whether the folder exists. Returns `boolean\|PEAR_Error` True if the folder exists.
`public Horde_Kolab_Storage_Data`	# `getData( Kolab_List $object_type = null, mixed $data_version = 1 )` Retrieve a handler for the data in this folder. Retrieve a handler for the data in this folder. Parameters `$object_type` $list The handler for the list of folders. `$data_version` Returns `Horde_Kolab_Storage_Data` The data handler.
`public null`	# `deleteMessage( string $id, boolean $trigger = true )` Delete the specified message from this folder. Delete the specified message from this folder. Parameters `$id` IMAP id of the message to be deleted. `$trigger` Should the folder be triggered? Returns `null` Implementation of `Horde_Kolab_Storage_Folder::deleteMessage()`
`public boolean`	# `moveMessage( string $id, string $folder )` Move the specified message to the specified folder. Move the specified message to the specified folder. Parameters `$id` IMAP id of the message to be moved. `$folder` Name of the receiving folder. Returns `boolean` True if successful. Implementation of `Horde_Kolab_Storage_Folder::moveMessage()`
`public null`	# `moveMessageToShare( string $id, string $share )` Move the specified message to the specified share. Move the specified message to the specified share. Parameters `$id` IMAP id of the message to be moved. `$share` Name of the receiving share. Returns `null` Implementation of `Horde_Kolab_Storage_Folder::moveMessageToShare()`
`public array`	# `getFormats( )` Retrieve the supported formats. Retrieve the supported formats. Returns `array` The names of the supported formats.
`public boolean`	# `saveObject( array & $object, integer $data_version, string $object_type, string $id = null, array & $old_object = null )` Save an object in this folder. Save an object in this folder. Parameters `$object` The array that holds the data of the object. `$data_version` The format handler version. `$object_type` The type of the kolab object. `$id` <p>The IMAP id of the old object if it existed before</p> `$old_object` <p>The array that holds the current data of the object.</p> Returns `boolean` True on success. Implementation of `Horde_Kolab_Storage_Folder::saveObject()`
`public array\|PEAR_Error`	# `parseMessage( integer $id, string $mime_type, boolean $parse_headers = true, array $formats = array('XML') )` Get an IMAP message and retrieve the Kolab Format object. Get an IMAP message and retrieve the Kolab Format object. Parameters `$id` The message to retrieve. `$mime_type` The mime type of the part to retrieve. `$parse_headers` Should the heades be Mime parsed? `$formats` The list of possible format parts. Returns `array\|PEAR_Error` An array that list the Kolab XML object text, the mime ID of the part with the XML object, the Mime parsed message and the Mime parsed headers if requested.
`public array\|PEAR_Error`	# `_getAnnotationData( )` Get annotation values on IMAP servers that do not support METADATA. Get annotation values on IMAP servers that do not support METADATA. Returns `array\|PEAR_Error` The anotations of this folder.
`public string\|PEAR_Error`	# `_getAnnotation( mixed $key )` Get an annotation value of this folder. Get an annotation value of this folder. Parameters `$key` key of the annotation to retrieve. Returns `string\|PEAR_Error` The anotation value.
`public boolean\|PEAR_Error`	# `_setAnnotation( mixed $key, mixed $value )` Set an annotation value of this folder. Set an annotation value of this folder. Parameters `$key` key of the annotation to change. `$value` new value. Returns `boolean\|PEAR_Error` True on success.
`public integer`	# `getFbrelevance( )` Get the free/busy relevance for this folder Get the free/busy relevance for this folder Returns `integer` Value containing the FB_RELEVANCE.
`public mixed`	# `setFbrelevance( integer $relevance )` Set the free/busy relevance for this folder Set the free/busy relevance for this folder Parameters `$relevance` Value containing the FB_RELEVANCE Returns `mixed` True on success or a PEAR_Error.
`public array`	# `getXfbaccess( )` Get the extended free/busy access settings for this folder Get the extended free/busy access settings for this folder Returns `array` Array containing the users with access to the extended information.
`public mixed`	# `setXfbaccess( array $access )` Set the extended free/busy access settings for this folder Set the extended free/busy access settings for this folder Parameters `$access` <p>Array containing the users with access to the extended information.</p> Returns `mixed` True on success or a PEAR_Error.

Constants summary
`string`	`ANNOT_ROOT` The root of the Kolab annotation hierarchy, used on the various IMAP folder that are used by Kolab clients. The root of the Kolab annotation hierarchy, used on the various IMAP folder that are used by Kolab clients.	# `'/shared/vendor/kolab/'`
`string`	`ANNOT_FOLDER_TYPE` The annotation, as defined by the Kolab format spec, that is used to store information about what groupware format the folder contains. The annotation, as defined by the Kolab format spec, that is used to store information about what groupware format the folder contains.	# `'/shared/vendor/kolab/folder-type'`
`string`	`ANNOT_SHARE_ATTR` Horde-specific annotations on the imap folder have this prefix. Horde-specific annotations on the imap folder have this prefix.	# `'/shared/vendor/horde/share-'`
`integer`	`FBRELEVANCE_ADMINS` Kolab specific free/busy relevance Kolab specific free/busy relevance	# `0`
`integer`	`FBRELEVANCE_READERS`	# `1`
`integer`	`FBRELEVANCE_NOBODY`	# `2`

Properties summary
`public Horde_Permission_Kolab`	`$_perms` The permission handler for the folder. The permission handler for the folder.	#
`public array`	`$_annotation_data` Links to the annotation data handlers for this folder. Links to the annotation data handlers for this folder.	#
`public boolean`	`$tainted` Indicate that the folder data has been modified from the outside and all Data handlers need to synchronize. Indicate that the folder data has been modified from the outside and all Data handlers need to synchronize.	# `false`

Packages

Classes

Interfaces

Class Horde_Kolab_Storage_Folder_Base

Parameters

Parameters

Returns

Parameters

Returns

Returns

Implementation of

Returns

Implementation of

Returns

Since

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns