Class Kolab_Folder

Description

The Kolab_Folder class represents an IMAP folder on the Kolab server.

$Horde: framework/Kolab_Storage/lib/Horde/Kolab/Storage/Folder.php,v 1.7.2.21 2010/06/22 09:31:39 wrobel Exp $

Copyright 2004-2009 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/Folder.php (line 74)


	
			
Variable Summary
Method Summary
 Kolab_Folder Kolab_Folder ([string $name = null])
 boolean|PEAR_Error accessible ()
 boolean|PEAR_Error delete ()
 boolean|PEAR_Error deleteACL ($user $user)
 boolean|PEAR_Error deleteMessage (string $id, [boolean $trigger = true])
 boolean|PEAR_Error exists ()
 array|PEAR_Error getACL ()
 mixed getAttribute (string $attribute)
 Kolab_Data|PEAR_Error &getData ([ $object_type = null], [ $data_version = 1], Kolab_List $list)
 array getFormats ()
 mixed getKolabAttribute (string $attribute)
 string getName ()
 string|PEAR_Error getOwner ()
 string getShareId ()
 array|PEAR_Error getStatus ()
 string|PEAR_Error getSubpath ([string $name = null])
 string getTitle ()
 string|PEAR_Error getType ()
 array getXfbaccess ()
 boolean|PEAR_Error hasPermission (string $userid, integer $permission, [string $creator = null])
 boolean isDefault ()
 boolean|PEAR_Error moveMessage (string $id, string $folder)
 boolean|PEAR_Error moveMessageToShare (string $id, string $share)
 array|PEAR_Error parseMessage (int $id, string $mime_type, [boolean $parse_headers = true], [array $formats = array('XML')])
 boolean|PEAR_Error save ([array $attributes = null])
 boolean|PEAR_Error saveObject ( &$object, int $data_version, string $object_type, [string $id = null], [ &$old_object = null], array $object, array $old_object)
 boolean|PEAR_Error setACL ($user $user, $acl $acl)
 mixed setFbrelevance (int $relevance)
 void setFolder (string $name)
 void setList ( &$list, Kolab_List $list)
 void setName (string $name)
 boolean|PEAR_Error setPermission ( &$perms, [boolean $update = true], Horde_Permission_Kolab $perms)
 mixed setXfbaccess (array $access)
 boolean|PEAR_Error trigger ([string $name = null])
 boolean|PEAR_Error triggerUrl (string $url)
 string|PEAR_Error _getAnnotation ($key $key)
 array|PEAR_Error _getAnnotationData ()
 string _prepareNewMessage ()
 boolean|PEAR_Error _setAnnotation ($key $key, $value $value)
 array __sleep ()
 void __wakeup ()
Variables
string $name (line 81)

The folder name.

string $new_name (line 89)

A new folder name if the folder should be renamed on the next save.

boolean $tainted = false (line 181)

Indicate that the folder data has been modified from the outside and all Data handlers need to synchronize.

array $_annotation_data (line 173)

Links to the annotation data handlers for this folder.

array $_attributes (line 131)

Additional Horde folder attributes.

array $_data (line 166)

Links to the data handlers for this folder.

boolean $_default (line 145)

Is this a default folder?

array $_kolab_attributes (line 138)

Additional Kolab folder attributes.

Kolab_List $_list (line 96)

The handler for the list of Kolab folders.

string $_owner (line 117)

The owner of this folder.

Horde_Permission_Kolab $_perms (line 159)

The permission handler for the folder.

string $_subpath (line 124)

The pure folder.

string $_title (line 152)

The title of this folder.

string $_type (line 103)

The type of this folder.

string $_type_annotation (line 110)

The complete folder type annotation (type + default).

Methods
Constructor Kolab_Folder (line 188)

Creates a Kolab Folder representation.

Kolab_Folder Kolab_Folder ([string $name = null])
  • string $name: Name of the folder
accessible (line 673)

Returns whether the folder is accessible.

  • return: True if the folder can be accessed.
boolean|PEAR_Error accessible ()
delete (line 460)

Delete this folder.

  • return: True if the operation succeeded.
boolean|PEAR_Error delete ()
deleteACL (line 1445)

Delete the IMAP ACL for a user on this folder.

  • return: True on success.
boolean|PEAR_Error deleteACL ($user $user)
  • $user $user: The user for whom the ACL should be deleted.
deleteMessage (line 734)

Delete the specified message from this folder.

  • return: True if successful.
boolean|PEAR_Error deleteMessage (string $id, [boolean $trigger = true])
  • string $id: IMAP id of the message to be deleted.
  • boolean $trigger: Should the folder be triggered?
exists (line 653)

Returns whether the folder exists.

  • return: True if the folder exists.
boolean|PEAR_Error exists ()
getACL (line 1355)

Return the IMAP ACL of this folder.

  • return: An array with IMAP ACL.
array|PEAR_Error getACL ()
getAttribute (line 600)

Returns one of the attributes of the folder, or an empty string if it isn't defined.

  • return: The value of the attribute, an empty string or an error.
mixed getAttribute (string $attribute)
  • string $attribute: The attribute to retrieve.
getData (line 695)

Retrieve a handler for the data in this folder.

  • return: The data handler.
Kolab_Data|PEAR_Error &getData ([ $object_type = null], [ $data_version = 1], Kolab_List $list)
  • Kolab_List $list: The handler for the list of folders.
  • $object_type
  • $data_version
getFbrelevance (line 1571)

Get the free/busy relevance for this folder

  • return: Value containing the FB_RELEVANCE.
int getFbrelevance ()
getFormats (line 844)

Retrieve the supported formats.

  • return: The names of the supported formats.
array getFormats ()
getKolabAttribute (line 630)

Returns one of the Kolab attributes of the folder, or an empty string if it isn't defined.

  • return: The value of the attribute, an empty string or an error.
mixed getKolabAttribute (string $attribute)
  • string $attribute: The attribute to retrieve.
getName (line 475)

Return the name of the folder.

  • return: The name of the folder.
  • access: public
string getName ()
getOwner (line 490)

Returns the owner of the folder.

  • return: The owner of this folder.
string|PEAR_Error getOwner ()
getPermission (line 1303)

Returns the permissions from this storage object.

  • return: The permissions on the share.
Horde_Permission_Kolab &getPermission ()
getShareId (line 262)

Return the share ID of this folder.

  • return: The share ID of this folder.
string getShareId ()
getStatus (line 1172)

Report the status of this folder.

  • return: An array listing the validity ID, the next IMAP ID and an array of IMAP IDs.
array|PEAR_Error getStatus ()
getSubpath (line 527)

Returns the subpath of the folder.

  • return: The subpath of this folder.
string|PEAR_Error getSubpath ([string $name = null])
  • string $name: Name of the folder that should be triggered.
getTitle (line 543)

Returns a readable title for this folder.

  • return: The folder title.
string getTitle ()
getType (line 556)

The type of this folder.

  • return: The folder type.
string|PEAR_Error getType ()
getXfbaccess (line 1622)

Get the extended free/busy access settings for this folder

  • return: Array containing the users with access to the extended information.
array getXfbaccess ()
hasPermission (line 1285)

Checks to see if a user has a given permission.

  • return: Whether or not $userid has $permission.
boolean|PEAR_Error hasPermission (string $userid, integer $permission, [string $creator = null])
  • string $userid: The userid of the user.
  • integer $permission: A PERMS_* constant to test for.
  • string $creator: The creator of the shared object.
isDefault (line 582)

Is this a default folder?

  • return: Boolean that indicates the default status.
boolean isDefault ()
moveMessage (line 778)

Move the specified message to the specified folder.

  • return: True if successful.
boolean|PEAR_Error moveMessage (string $id, string $folder)
  • string $id: IMAP id of the message to be moved.
  • string $folder: Name of the receiving folder.
moveMessageToShare (line 820)

Move the specified message to the specified share.

  • return: True if successful.
boolean|PEAR_Error moveMessageToShare (string $id, string $share)
  • string $id: IMAP id of the message to be moved.
  • string $share: Name of the receiving share.
parseMessage (line 1090)

Get an IMAP message and retrieve the Kolab Format object.

  • return: 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.
array|PEAR_Error parseMessage (int $id, string $mime_type, [boolean $parse_headers = true], [array $formats = array('XML')])
  • int $id: The message to retrieve.
  • string $mime_type: The mime type of the part to retrieve.
  • boolean $parse_headers: Should the heades be MIME parsed?
  • array $formats: The list of possible format parts.
save (line 281)

Saves the folder.

  • return: True on success.
boolean|PEAR_Error save ([array $attributes = null])
  • array $attributes: An array of folder attributes. You can set any attribute but there are a few special ones like 'type', 'default', 'owner' and 'desc'.
saveObject (line 875)

Save an object in this folder.

  • return: True on success.
boolean|PEAR_Error saveObject ( &$object, int $data_version, string $object_type, [string $id = null], [ &$old_object = null], array $object, array $old_object)
  • array $object: The array that holds the data of the object.
  • int $data_version: The format handler version.
  • string $object_type: The type of the kolab object.
  • string $id: The IMAP id of the old object if it existed before
  • array $old_object: The array that holds the current data of the object.
  • &$object
  • &$old_object
setACL (line 1404)

Set the IMAP ACL of this folder.

  • return: True on success.
boolean|PEAR_Error setACL ($user $user, $acl $acl)
  • $user $user: The user for whom the ACL should be set.
  • $acl $acl: The new ACL value.
setFbrelevance (line 1596)

Set the free/busy relevance for this folder

  • return: True on success or a PEAR_Error.
mixed setFbrelevance (int $relevance)
  • int $relevance: Value containing the FB_RELEVANCE
setFolder (line 252)

Set a new IMAP folder name for the folder. The new name will be realized when saving the folder.

void setFolder (string $name)
  • string $name: The new folder name.
setList (line 230)

Set the list handler.

void setList ( &$list, Kolab_List $list)
  • Kolab_List $list: The handler for the list of folders.
  • &$list
setName (line 241)

Set a new name for the folder. The new name will be realized when saving the folder.

void setName (string $name)
  • string $name: The new folder name
setPermission (line 1330)

Sets the permissions on the share.

  • return: True on success.
boolean|PEAR_Error setPermission ( &$perms, [boolean $update = true], Horde_Permission_Kolab $perms)
  • Horde_Permission_Kolab $perms: Permission object to store on the object.
  • boolean $update: Save the updated information?
  • &$perms
setXfbaccess (line 1639)

Set the extended free/busy access settings for this folder

  • return: True on success or a PEAR_Error.
mixed setXfbaccess (array $access)
  • array $access: Array containing the users with access to the extended information.
trigger (line 1207)

Triggers any required updates after changes within the folder. This is currently only required for handling free/busy information with Kolab.

  • return: True if successfull.
boolean|PEAR_Error trigger ([string $name = null])
  • string $name: Name of the folder that should be triggered.
triggerUrl (line 1249)

Triggers a URL.

  • return: True if successfull.
boolean|PEAR_Error triggerUrl (string $url)
  • string $url: The URL to be triggered.
_getAnnotation (line 1494)

Get an annotation value of this folder.

  • return: The anotation value.
string|PEAR_Error _getAnnotation ($key $key)
  • $key $key: The key of the annotation to retrieve.
_getAnnotationData (line 1481)

Get annotation values on IMAP server that do not support METADATA.

  • return: The anotations of this folder.
array|PEAR_Error _getAnnotationData ()
_prepareNewMessage (line 1154)

Prepares a new kolab Groupeware message.

  • return: The MIME message
string _prepareNewMessage ()
_setAnnotation (line 1533)

Set an annotation value of this folder.

  • return: True on success.
boolean|PEAR_Error _setAnnotation ($key $key, $value $value)
  • $key $key: The key of the annotation to change.
  • $value $value: The new value.
__sleep (line 217)

Returns the properties that need to be serialized.

  • return: List of serializable properties.
array __sleep ()
__wakeup (line 197)

Initializes the object.

void __wakeup ()

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