PHP Класс Horde_Kolab_Storage_Folder_Base, horde

Copyright 2004-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Автор: Stuart Binge ([email protected])
Автор: Gunnar Wrobel ([email protected])
Автор: Thomas Jarosch ([email protected])
Наследование: implements Horde_Kolab_Storage_Folder
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_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.

Описание методов

__construct() публичный Метод

Constructor.
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.

__construct() публичный Метод

Constructor.
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.

_getAnnotation() публичный Метод

Get an annotation value of this folder.
public _getAnnotation ( $key ) : string | PEAR_Error
$key The key of the annotation to retrieve.
Результат string | PEAR_Error The anotation value.

_getAnnotationData() публичный Метод

Get annotation values on IMAP servers that do not support METADATA.
public _getAnnotationData ( ) : array | PEAR_Error
Результат array | PEAR_Error The anotations of this folder.

_setAnnotation() публичный Метод

Set an annotation value 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.

delete() публичный Метод

Delete this folder.
public delete ( ) : boolean | PEAR_Error
Результат boolean | PEAR_Error True if the operation succeeded.

deleteMessage() публичный Метод

Delete the specified message from this folder.
public deleteMessage ( string $id, boolean $trigger = true ) : null
$id string IMAP id of the message to be deleted.
$trigger boolean Should the folder be triggered?
Результат null

exists() публичный Метод

Returns whether the folder exists.
public exists ( ) : boolean | PEAR_Error
Результат boolean | PEAR_Error True if the folder exists.

get() публичный Метод

Fetch a data value.
public get ( string $key ) : mixed
$key string The name of the data value to fetch.
Результат mixed The data value

getAttribute() публичный Метод

Returns one of the attributes of the folder, or an empty string if it isn't defined.
public getAttribute ( string $attribute ) : mixed
$attribute string The attribute to retrieve.
Результат mixed The value of the attribute, an empty string or an error.

getData() публичный Метод

Retrieve a handler for the data in this folder.
public getData ( $object_type = null, $data_version = 1 ) : Horde_Kolab_Storage_Data
Результат Horde_Kolab_Storage_Data The data handler.

getFbrelevance() публичный Метод

Get the free/busy relevance for this folder
public getFbrelevance ( ) : integer
Результат integer Value containing the FB_RELEVANCE.

getFormats() публичный Метод

Retrieve the supported formats.
public getFormats ( ) : array
Результат array The names of the supported formats.

getKolabAttribute() публичный Метод

Returns one of the Kolab attributes of the folder, or an empty string if it isn't defined.
public getKolabAttribute ( string $attribute ) : mixed
$attribute string The attribute to retrieve.
Результат mixed The value of the attribute, an empty string or an error.

getNamespace() публичный Метод

Return the namespace type of the folder.
public getNamespace ( ) : string
Результат string The namespace type of the folder.

getOwner() публичный Метод

Returns the owner of the folder.
public getOwner ( ) : string
Результат string The owner of this folder.

getParent() публичный Метод

Returns the folder parent.
public getParent ( ) : string
Результат string The parent of this folder.

getPath() публичный Метод

Return the storage path of the folder.
public getPath ( ) : string
Результат string The storage path of the folder.

getPrefix() публичный Метод

Return the namespace prefix of the folder.
public getPrefix ( ) : string
Результат string The namespace prefix of the folder.

getSubpath() публичный Метод

Returns the folder path without namespace components.
public getSubpath ( ) : string
Результат string The subpath of this folder.

getTitle() публичный Метод

Returns a readable title for this folder.
public getTitle ( ) : string
Результат string The folder title.

getType() публичный Метод

The type of this folder.
public getType ( ) : string
Результат string The folder type.

getWithNull() публичный Метод

Fetch a data value and accept a missing value (represented by the return value NULL).
public getWithNull ( string $key ) : mixed
$key string The name of the data value to fetch.
Результат mixed The data value

getXfbaccess() публичный Метод

Get the extended free/busy access settings for this folder
public getXfbaccess ( ) : array
Результат array Array containing the users with access to the extended information.

isDefault() публичный Метод

Is this a default folder?
public isDefault ( ) : boolean
Результат boolean Boolean that indicates the default status.

moveMessage() публичный Метод

Move the specified message to the specified folder.
public moveMessage ( string $id, string $folder ) : boolean
$id string IMAP id of the message to be moved.
$folder string Name of the receiving folder.
Результат boolean True if successful.

moveMessageToShare() публичный Метод

Move the specified message to the specified share.
public moveMessageToShare ( string $id, string $share ) : null
$id string IMAP id of the message to be moved.
$share string Name of the receiving share.
Результат null

parseMessage() публичный Метод

Get an IMAP message and retrieve the Kolab Format object.
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.

save() публичный Метод

Saves the folder.
public save ( array $attributes = null ) : null
$attributes array An array of folder attributes. You can set any attribute but there are a few special ones like 'type', 'default', 'owner' and 'desc'.
Результат null

saveObject() публичный Метод

Save an object in this folder.
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.

setFbrelevance() публичный Метод

Set the free/busy relevance for this folder
public setFbrelevance ( integer $relevance ) : mixed
$relevance integer Value containing the FB_RELEVANCE
Результат mixed True on success or a PEAR_Error.

setXfbaccess() публичный Метод

Set the extended free/busy access settings for this folder
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.

Описание свойств

$_annotation_data публичное свойство

Links to the annotation data handlers for this folder.
public array $_annotation_data
Результат array

$_perms публичное свойство

The permission handler for the folder.
public Horde_Permission_Kolab $_perms
Результат Horde_Permission_Kolab

$tainted публичное свойство

Indicate that the folder data has been modified from the outside and all Data handlers need to synchronize.
public bool $tainted
Результат boolean