PHP 클래스 Horde_Kolab_Storage_Data_Base, 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.
상속: implements Horde_Kolab_Storage_Data, implements Horde_Kolab_Storage_Data_Query
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_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.

메소드 상세

__construct() 공개 메소드

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() 공개 메소드

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 )
$object_ids array | string Id(s) of the object to be deleted.

deleteAll() 공개 메소드

Delete all objects from this data set.
public deleteAll ( )

deleteBackendIds() 공개 메소드

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() 공개 메소드

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.
리턴 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.

fetchPart() 공개 메소드

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.
리턴 resource The message part as stream resource.

generateUid() 공개 메소드

Generate a unique object ID.
public generateUid ( ) : string
리턴 string The unique ID.

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.

getQuery() 공개 메소드

Return a registered query.
public getQuery ( string $name = null ) : Horde_Kolab_Storage_Query
$name string The query name.
리턴 Horde_Kolab_Storage_Query The requested query.

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 ) : 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.

move() 공개 메소드

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() 공개 메소드

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.

registerQuery() 공개 메소드

Register a query to be updated if the underlying data changes.
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 setLogger ( Horde_Log_Logger $logger )
$logger Horde_Log_Logger

synchronize() 공개 메소드

Synchronize the data information with the information from the backend.
public synchronize ( array $params = [] )
$params array Additional parameters.

프로퍼티 상세

$_driver 보호되어 있는 프로퍼티

The driver for accessing the Kolab storage system.
protected Horde_Kolab_Storage_Driver $_driver
리턴 Horde_Kolab_Storage_Driver

$_factory 보호되어 있는 프로퍼티

The factory for generating additional resources.
protected Horde_Kolab_Storage_Factory $_factory
리턴 Horde_Kolab_Storage_Factory

$_folder 보호되어 있는 프로퍼티

The link to the parent folder object.
protected Horde_Kolab_Storage_Folder $_folder
리턴 Horde_Kolab_Storage_Folder

$_logger 보호되어 있는 프로퍼티

Logger instance, or stub.
protected $_logger

$_queries 보호되어 있는 프로퍼티

The list of registered queries.
protected array $_queries
리턴 array

$_type 보호되어 있는 프로퍼티

The folder type.
protected string $_type
리턴 string

$_version 보호되어 있는 프로퍼티

The version of the data.
protected int $_version
리턴 integer