PHP Интерфейс Horde_Kolab_Storage_Data, horde

Copyright 2011-2014 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.
См. ссылку: http://pear.horde.org/index.php?package=Kolab_Storage
Автор: Gunnar Wrobel ([email protected])
Наследование: extends Horde_Kolab_Storage_Queriable
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
create ( &$object, boolean $raw = false ) : string Create a new object.
delete ( array | string $object_ids ) : null Delete the specified objects from this data set.
deleteAll ( ) : null Delete all objects from this data set.
deleteBackendIds ( array | string $uids ) : null Delete the specified messages from this folder.
fetch ( array $uids ) : array Retrieves the objects for the given UIDs.
fetchComplete ( string $uid ) : array Retrieves the complete message for the given UID.
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.
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 ) : null Modify an existing object.
move ( string $object_id, string $new_folder ) : null Move the specified message from the current folder into a new folder.
objectIdExists ( string $object_id ) : boolean Check if the given object ID exists.
setLogger ( Horde_Log_Logger $logger ) Set a logger.

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

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

Create a new object.
public create ( &$object, boolean $raw = false ) : string
$raw boolean True if the data to be stored has been provided in raw format.
Результат string The ID of the new object or true in case the backend does not support this return value.

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

Delete the specified objects from this data set.
public delete ( array | string $object_ids ) : null
$object_ids array | string Id(s) of the object to be deleted.
Результат null

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

Delete all objects from this data set.
public deleteAll ( ) : null
Результат null

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

Delete the specified messages from this folder.
public deleteBackendIds ( array | string $uids ) : null
$uids array | string Backend id(s) of the message to be deleted.
Результат null

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

Retrieves the objects for the given UIDs.
public fetch ( array $uids ) : array
$uids array The message UIDs.
Результат array An array of objects.

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

Retrieves the complete message for the given UID.
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.

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

Returns the specified attachment.
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.

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

Return the ID of the current user.
public getAuth ( ) : string
Результат string The current user.

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

Return the backend ID for the given object ID.
public getBackendId ( $object_id ) : string
Результат string The backend ID for the object.

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

Retrieve the list of object duplicates.
public getDuplicates ( ) : array
Результат array The list of duplicates.

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

Retrieve the list of object errors.
public getErrors ( ) : array
Результат array The list of errors.

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

Return the ID of this data handler.
public getId ( ) : string
Результат string The ID.

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

Return the ID parameters for this data handler.
public getIdParameters ( ) : array
Результат array The ID parameters.

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

Return the specified object.
public getObject ( string $object_id ) : array
$object_id string The object id.
Результат array The object data as an array.

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

Retrieve an object in the current folder by backend id.
public getObjectByBackendId ( string $uid ) : array
$uid string Backend id of the object to be returned.
Результат array An array of all objects.

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

Retrieve all object ids in the current folder.
public getObjectIds ( ) : array
Результат array The object ids.

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

Return the mapping of object IDs to backend IDs.
public getObjectToBackend ( ) : array
Результат array The object to backend mapping.

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

Retrieve all objects in the current folder.
public getObjects ( ) : array
Результат array An array of all objects.

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

Retrieve all objects in the current folder by backend id.
public getObjectsByBackendId ( ) : array
Результат array An array of all objects.

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

Return the folder path for this data handler.
public getPath ( ) : string
Результат string The folder path.

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

Report the status of this folder.
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.

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

Return the data type represented by this object.
public getType ( ) : string
Результат string The type of data this instance handles.

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

Return the data version.
public getVersion ( ) : string
Результат string The data version.

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

Modify an existing object.
public modify ( array $object, boolean $raw = false ) : null
$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.
Результат null

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

Move the specified message from the current folder into a new folder.
public move ( string $object_id, string $new_folder ) : null
$object_id string ID of the message to be moved.
$new_folder string Target folder.
Результат null

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

Check if the given object ID exists.
public objectIdExists ( string $object_id ) : boolean
$object_id string The object ID.
Результат boolean True if the ID was found, false otherwise.

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

Set a logger.
public setLogger ( Horde_Log_Logger $logger )
$logger Horde_Log_Logger The logger instance.