PHP 인터페이스 Horde_Kolab_Storage_Data, horde

링크 보기: 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.