PHP Class Horde_Kolab_Storage_Data_Base, horde

See link: http://pear.horde.org/index.php?package=Kolab_Storage

Author: Gunnar Wrobel ([email protected])

Inheritance: implements Horde_Kolab_Storage_Data, implements Horde_Kolab_Storage_Data_Query

ファイルを表示 Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_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.

Public Methods

Method	Description
__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.

Method Details

__construct() public method

Constructor.

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.

create() public method

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.
return	string	The ID of the new object or true in case the backend does not support this return value.

delete() public method

Delete the specified objects from this data set.

public delete ( array \| string $object_ids )
$object_ids	array \| string	Id(s) of the object to be deleted.

deleteAll() public method

Delete all objects from this data set.

public deleteAll ( )

deleteBackendIds() public method

Delete the specified messages from this folder.

public deleteBackendIds ( array \| string $uids )
$uids	array \| string	Backend id(s) of the message to be deleted.

fetch() public method

Retrieves the objects for the given UIDs.

public fetch ( array $uids, boolean $raw = false ) : array
$uids	array	The message UIDs.
$raw	boolean	True if the raw format should be returned rather than the parsed data.
return	array	An array of objects.

fetchComplete() public method

Retrieves the complete message for the given UID.

public fetchComplete ( string $uid ) : array
$uid	string	The message UID.
return	array	The message encapsuled as an array that contains a Horde_Mime_Headers and a Horde_Mime_Part object.

fetchPart() public method

Retrieves the body part for the given UID and mime part ID.

public fetchPart ( string $uid, string $id ) : resource
$uid	string	The message UID.
$id	string	The mime part ID.
return	resource	The message part as stream resource.

generateUid() public method

Generate a unique object ID.

public generateUid ( ) : string
return	string	The unique ID.

getAttachment() public method

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.
return	resource	An open stream to the attachment data.

getAuth() public method

Return the ID of the current user.

public getAuth ( ) : string
return	string	The current user.

getBackendId() public method

Return the backend ID for the given object ID.

public getBackendId ( $object_id ) : string
return	string	The backend ID for the object.

getDuplicates() public method

Retrieve the list of object duplicates.

public getDuplicates ( ) : array
return	array	The list of duplicates.

getErrors() public method

Retrieve the list of object errors.

public getErrors ( ) : array
return	array	The list of errors.

getId() public method

Return the ID of this data handler.

public getId ( ) : string
return	string	The ID.

getIdParameters() public method

Return the ID parameters for this data handler.

public getIdParameters ( ) : array
return	array	The ID parameters.

getObject() public method

Return the specified object.

public getObject ( string $object_id ) : array
$object_id	string	The object id.
return	array	The object data as an array.

getObjectByBackendId() public method

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.
return	array	An array of all objects.

getObjectIds() public method

Retrieve all object ids in the current folder.

public getObjectIds ( ) : array
return	array	The object ids.

getObjectToBackend() public method

Return the mapping of object IDs to backend IDs.

public getObjectToBackend ( ) : array
return	array	The object to backend mapping.

getObjects() public method

Retrieve all objects in the current folder.

public getObjects ( ) : array
return	array	An array of all objects.

getObjectsByBackendId() public method

Retrieve all objects in the current folder by backend id.

public getObjectsByBackendId ( ) : array
return	array	An array of all objects.

getPath() public method

Return the folder path for this data handler.

public getPath ( ) : string
return	string	The folder path.

getQuery() public method

Return a registered query.

public getQuery ( string $name = null ) : Horde_Kolab_Storage_Query
$name	string	The query name.
return	Horde_Kolab_Storage_Query	The requested query.

getStamp() public method

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.
return	Horde_Kolab_Storage_Folder_Stamp	The stamp that can be used for detecting folder changes.

getType() public method

Return the data type represented by this object.

public getType ( ) : string
return	string	The type of data this instance handles.

getVersion() public method

Return the data version.

public getVersion ( ) : string
return	string	The data version.

modify() public method

Modify an existing object.

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.
return	string	The new backend ID of the modified object or true in case the backend does not support this return value.

move() public method

Move the specified message from the current folder into a new folder.

public move ( string $object_id, string $new_folder )
$object_id	string	ID of the message to be moved.
$new_folder	string	Target folder.

objectIdExists() public method

Check if the given object ID exists.

public objectIdExists ( string $object_id ) : boolean
$object_id	string	The object ID.
return	boolean	True if the ID was found, false otherwise.

registerQuery() public method

public registerQuery ( string $name, Horde_Kolab_Storage_Query $query )
$name	string	The query name.
$query	Horde_Kolab_Storage_Query	The query to register.

setLogger() public method

public setLogger ( Horde_Log_Logger $logger )
$logger	Horde_Log_Logger

synchronize() public method

Synchronize the data information with the information from the backend.

public synchronize ( array $params = [] )
$params	array	Additional parameters.

Property Details

$_driver protected_oe property

The driver for accessing the Kolab storage system.

protected Horde_Kolab_Storage_Driver $_driver
return	Horde_Kolab_Storage_Driver

$_factory protected_oe property

The factory for generating additional resources.

protected Horde_Kolab_Storage_Factory $_factory
return	Horde_Kolab_Storage_Factory

$_folder protected_oe property

The link to the parent folder object.

protected Horde_Kolab_Storage_Folder $_folder
return	Horde_Kolab_Storage_Folder

$_logger protected_oe property

Logger instance, or stub.

protected $_logger

$_queries protected_oe property

The list of registered queries.

protected array $_queries
return	array

$_type protected_oe property

The folder type.

protected string $_type
return	string

$_version protected_oe property

The version of the data.

protected int $_version
return	integer