| Свойство | Тип | Описание | |
|---|---|---|---|
| $_annotation_data | array | Links to the annotation data handlers for this folder. | |
| $_perms | Horde_Permission_Kolab | The permission handler for the folder. | |
| $tainted | boolean | Indicate that the folder data has been modified from the outside and all Data handlers need to synchronize. |
| Метод | Описание | |
|---|---|---|
| __construct ( Horde_Kolab_Storage_List $list, string $path ) | Constructor. | |
| __construct ( Horde_Kolab_Storage_List_Query_List $list, string $path ) | Constructor. | |
| _getAnnotation ( $key ) : string | PEAR_Error | Get an annotation value of this folder. | |
| _getAnnotationData ( ) : array | PEAR_Error | Get annotation values on IMAP servers that do not support METADATA. | |
| _setAnnotation ( $key, $value ) : boolean | PEAR_Error | Set an annotation value of this folder. | |
| delete ( ) : boolean | PEAR_Error | Delete this folder. | |
| deleteMessage ( string $id, boolean $trigger = true ) : null | Delete the specified message from this folder. | |
| exists ( ) : boolean | PEAR_Error | Returns whether the folder exists. | |
| get ( string $key ) : mixed | Fetch a data value. | |
| getAttribute ( string $attribute ) : mixed | Returns one of the attributes of the folder, or an empty string if it isn't defined. | |
| getData ( $object_type = null, $data_version = 1 ) : Horde_Kolab_Storage_Data | Retrieve a handler for the data in this folder. | |
| getFbrelevance ( ) : integer | Get the free/busy relevance for this folder | |
| getFormats ( ) : array | Retrieve the supported formats. | |
| getKolabAttribute ( string $attribute ) : mixed | Returns one of the Kolab attributes of the folder, or an empty string if it isn't defined. | |
| getNamespace ( ) : string | Return the namespace type of the folder. | |
| getOwner ( ) : string | Returns the owner of the folder. | |
| getParent ( ) : string | Returns the folder parent. | |
| getPath ( ) : string | Return the storage path of the folder. | |
| getPrefix ( ) : string | Return the namespace prefix of the folder. | |
| getSubpath ( ) : string | Returns the folder path without namespace components. | |
| getTitle ( ) : string | Returns a readable title for this folder. | |
| getType ( ) : string | The type of this folder. | |
| getWithNull ( string $key ) : mixed | Fetch a data value and accept a missing value (represented by the return value NULL). | |
| getXfbaccess ( ) : array | Get the extended free/busy access settings for this folder | |
| isDefault ( ) : boolean | Is this a default folder? | |
| moveMessage ( string $id, string $folder ) : boolean | Move the specified message to the specified folder. | |
| moveMessageToShare ( string $id, string $share ) : null | Move the specified message to the specified share. | |
| parseMessage ( integer $id, string $mime_type, boolean $parse_headers = true, array $formats = ['XML'] ) : array | PEAR_Error | Get an IMAP message and retrieve the Kolab Format object. | |
| save ( array $attributes = null ) : null | Saves the folder. | |
| saveObject ( array &$object, integer $data_version, string $object_type, string $id = null, array &$old_object = null ) : boolean | Save an object in this folder. | |
| setFbrelevance ( integer $relevance ) : mixed | Set the free/busy relevance for this folder | |
| setXfbaccess ( array $access ) : mixed | Set the extended free/busy access settings for this folder |
| Метод | Описание | |
|---|---|---|
| _init ( ) : null | Fetch the data array. |
| public __construct ( Horde_Kolab_Storage_List $list, string $path ) | ||
| $list | Horde_Kolab_Storage_List | The handler for the list of folders. |
| $path | string | Path of the folder. |
| public __construct ( Horde_Kolab_Storage_List_Query_List $list, string $path ) | ||
| $list | Horde_Kolab_Storage_List_Query_List | The query handler for the list of folders. |
| $path | string | Path of the folder. |
| public _getAnnotation ( $key ) : string | PEAR_Error | ||
| $key | The key of the annotation to retrieve. | |
| Результат | string | PEAR_Error | The anotation value. |
| public _getAnnotationData ( ) : array | PEAR_Error | ||
| Результат | array | PEAR_Error | The anotations of this folder. |
| public _setAnnotation ( $key, $value ) : boolean | PEAR_Error | ||
| $key | The key of the annotation to change. | |
| $value | The new value. | |
| Результат | boolean | PEAR_Error | True on success. |
| public getAttribute ( string $attribute ) : mixed | ||
| $attribute | string | The attribute to retrieve. |
| Результат | mixed | The value of the attribute, an empty string or an error. |
| public getData ( $object_type = null, $data_version = 1 ) : Horde_Kolab_Storage_Data | ||
| Результат | Horde_Kolab_Storage_Data | The data handler. |
| public getFbrelevance ( ) : integer | ||
| Результат | integer | Value containing the FB_RELEVANCE. |
| public getFormats ( ) : array | ||
| Результат | array | The names of the supported formats. |
| public getKolabAttribute ( string $attribute ) : mixed | ||
| $attribute | string | The attribute to retrieve. |
| Результат | mixed | The value of the attribute, an empty string or an error. |
| public getNamespace ( ) : string | ||
| Результат | string | The namespace type of the folder. |
| public getSubpath ( ) : string | ||
| Результат | string | The subpath of this folder. |
| public getWithNull ( string $key ) : mixed | ||
| $key | string | The name of the data value to fetch. |
| Результат | mixed | The data value |
| public getXfbaccess ( ) : array | ||
| Результат | array | Array containing the users with access to the extended information. |
| public parseMessage ( integer $id, string $mime_type, boolean $parse_headers = true, array $formats = ['XML'] ) : array | PEAR_Error | ||
| $id | integer | The message to retrieve. |
| $mime_type | string | The mime type of the part to retrieve. |
| $parse_headers | boolean | Should the heades be Mime parsed? |
| $formats | array | The list of possible format parts. |
| Результат | 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 saveObject ( array &$object, integer $data_version, string $object_type, string $id = null, array &$old_object = null ) : boolean | ||
| $object | array | The array that holds the data of the object. |
| $data_version | integer | The format handler version. |
| $object_type | string | The type of the kolab object. |
| $id | string | The IMAP id of the old object if it existed before |
| $old_object | array | The array that holds the current data of the object. |
| Результат | boolean | True on success. |
| public setFbrelevance ( integer $relevance ) : mixed | ||
| $relevance | integer | Value containing the FB_RELEVANCE |
| Результат | mixed | True on success or a PEAR_Error. |
| public setXfbaccess ( array $access ) : mixed | ||
| $access | array | Array containing the users with access to the extended information. |
| Результат | mixed | True on success or a PEAR_Error. |
| public array $_annotation_data | ||
| Результат | array | |
| public Horde_Permission_Kolab $_perms | ||
| Результат | Horde_Permission_Kolab | |
| public bool $tainted | ||
| Результат | boolean | |