| Свойство | Тип | Описание | |
|---|---|---|---|
| $_driver | Horde_Kolab_Storage_Driver | The driver for accessing the Kolab storage system. | |
| $_factory | Horde_Kolab_Storage_Factory | The factory for generating additional resources. | |
| $_folder | Horde_Kolab_Storage_Folder | The link to the parent folder object. | |
| $_logger | Logger instance, or stub. | ||
| $_queries | array | The list of registered queries. | |
| $_type | string | The folder type. | |
| $_version | integer | The version of the data. |
| Метод | Описание | |
|---|---|---|
| __construct ( Horde_Kolab_Storage_Folder $folder, Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Factory $factory, string $type = null, integer $version = 1 ) | Constructor. | |
| create ( &$object, boolean $raw = false ) : string | Create a new object. | |
| delete ( array | string $object_ids ) | Delete the specified objects from this data set. | |
| deleteAll ( ) | Delete all objects from this data set. | |
| deleteBackendIds ( array | string $uids ) | Delete the specified messages from this folder. | |
| fetch ( array $uids, boolean $raw = false ) : array | Retrieves the objects for the given UIDs. | |
| fetchComplete ( string $uid ) : array | Retrieves the complete message for the given UID. | |
| fetchPart ( string $uid, string $id ) : resource | Retrieves the body part for the given UID and mime part ID. | |
| generateUid ( ) : string | Generate a unique object ID. | |
| getAttachment ( string $object_id, string $attachment_id ) : resource | Returns the specified attachment. | |
| getAuth ( ) : string | Return the ID of the current user. | |
| getBackendId ( $object_id ) : string | Return the backend ID for the given object ID. | |
| getDuplicates ( ) : array | Retrieve the list of object duplicates. | |
| getErrors ( ) : array | Retrieve the list of object errors. | |
| getId ( ) : string | Return the ID of this data handler. | |
| getIdParameters ( ) : array | Return the ID parameters for this data handler. | |
| getObject ( string $object_id ) : array | Return the specified object. | |
| getObjectByBackendId ( string $uid ) : array | Retrieve an object in the current folder by backend id. | |
| getObjectIds ( ) : array | Retrieve all object ids in the current folder. | |
| getObjectToBackend ( ) : array | Return the mapping of object IDs to backend IDs. | |
| getObjects ( ) : array | Retrieve all objects in the current folder. | |
| getObjectsByBackendId ( ) : array | Retrieve all objects in the current folder by backend id. | |
| getPath ( ) : string | Return the folder path for this data handler. | |
| getQuery ( string $name = null ) : Horde_Kolab_Storage_Query | Return a registered query. | |
| getStamp ( Horde_Kolab_Storage_Folder_Stamp $previous = null ) : Horde_Kolab_Storage_Folder_Stamp | Report the status of this folder. | |
| getType ( ) : string | Return the data type represented by this object. | |
| getVersion ( ) : string | Return the data version. | |
| modify ( array $object, boolean $raw = false ) : string | Modify an existing object. | |
| move ( string $object_id, string $new_folder ) | Move the specified message from the current folder into a new folder. | |
| objectIdExists ( string $object_id ) : boolean | Check if the given object ID exists. | |
| registerQuery ( string $name, Horde_Kolab_Storage_Query $query ) | Register a query to be updated if the underlying data changes. | |
| setLogger ( Horde_Log_Logger $logger ) | ||
| synchronize ( array $params = [] ) | Synchronize the data information with the information from the backend. |
| public __construct ( Horde_Kolab_Storage_Folder $folder, Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Factory $factory, string $type = null, integer $version = 1 ) | ||
| $folder | Horde_Kolab_Storage_Folder | The folder to retrieve the data from. |
| $driver | Horde_Kolab_Storage_Driver | The primary connection driver. |
| $factory | Horde_Kolab_Storage_Factory | The factory. |
| $type | string | The type of data we want to access in the folder. |
| $version | integer | Format version of the object data. |
| public deleteBackendIds ( array | string $uids ) | ||
| $uids | array | string | Backend id(s) of the message to be deleted. |
| public fetchComplete ( string $uid ) : array | ||
| $uid | string | The message UID. |
| Результат | array | The message encapsuled as an array that contains a Horde_Mime_Headers and a Horde_Mime_Part object. |
| public generateUid ( ) : string | ||
| Результат | string | The unique ID. |
| public getAttachment ( string $object_id, string $attachment_id ) : resource | ||
| $object_id | string | The object id. @since Kolab_Storage 2.1.0 |
| $attachment_id | string | The attachment id. |
| Результат | resource | An open stream to the attachment data. |
| public getBackendId ( $object_id ) : string | ||
| Результат | string | The backend ID for the object. |
| public getDuplicates ( ) : array | ||
| Результат | array | The list of duplicates. |
| public getIdParameters ( ) : array | ||
| Результат | array | The ID parameters. |
| public getObjectByBackendId ( string $uid ) : array | ||
| $uid | string | Backend id of the object to be returned. |
| Результат | array | An array of all objects. |
| public getObjectIds ( ) : array | ||
| Результат | array | The object ids. |
| public getObjectToBackend ( ) : array | ||
| Результат | array | The object to backend mapping. |
| public getObjects ( ) : array | ||
| Результат | array | An array of all objects. |
| public getObjectsByBackendId ( ) : array | ||
| Результат | array | An array of all objects. |
| public getStamp ( Horde_Kolab_Storage_Folder_Stamp $previous = null ) : Horde_Kolab_Storage_Folder_Stamp | ||
| $previous | Horde_Kolab_Storage_Folder_Stamp | The previous stamp, if available. |
| Результат | Horde_Kolab_Storage_Folder_Stamp | The stamp that can be used for detecting folder changes. |
| public getVersion ( ) : string | ||
| Результат | string | The data version. |
| public modify ( array $object, boolean $raw = false ) : string | ||
| $object | array | The array that holds the updated object data. |
| $raw | boolean | True if the data to be stored has been provided in raw format. |
| Результат | string | The new backend ID of the modified object or true in case the backend does not support this return value. |
| public objectIdExists ( string $object_id ) : boolean | ||
| $object_id | string | The object ID. |
| Результат | boolean | True if the ID was found, false otherwise. |
| public registerQuery ( string $name, Horde_Kolab_Storage_Query $query ) | ||
| $name | string | The query name. |
| $query | Horde_Kolab_Storage_Query | The query to register. |
| public synchronize ( array $params = [] ) | ||
| $params | array | Additional parameters. |
| protected Horde_Kolab_Storage_Driver $_driver | ||
| Результат | Horde_Kolab_Storage_Driver | |
| protected Horde_Kolab_Storage_Factory $_factory | ||
| Результат | Horde_Kolab_Storage_Factory | |
| protected Horde_Kolab_Storage_Folder $_folder | ||
| Результат | Horde_Kolab_Storage_Folder | |
| protected array $_queries | ||
| Результат | array | |
