PHP 클래스 Horde_Kolab_Storage_Object, horde

상속: implements ArrayAccess, implements Serializable
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_backend_id string The object ID within the backend.
$_content resource The content string representing the object data.
$_data array The object data.
$_driver Horde_Kolab_Storage_Driver The driver for accessing the backend.
$_errors array The collection of parse errors (if any).
$_folder string The folder that holds the object within the backend.
$_headers Horde_Mime_Headers The MIME headers of the object envelope.
$_mime_part_id string The ID of the MIME part carrying the object data.
$_structure Horde_Mime_Part The message structure.
$_type string The object type.

공개 메소드들

메소드 설명
create ( Horde_Kolab_Storage_Folder $folder, Horde_Kolab_Storage_Object_Writer $data, string $type ) : boolean | string Create a new object in the backend.
generateUid ( ) : string Generate a unique object ID.
getBackendId ( )
getContent ( ) : resource Fetch the raw content representing the object data.
getCurrentContent ( ) : resource Return the current content value representing the object data. This call does not attempt to fetch the content from the backend.
getData ( ) : array Fetch the object data.
getHeaders ( ) : Horde_Mime_Headers Return the MIME headers of the object envelope.
getParseErrors ( )
getType ( ) : string Return the object type.
getUid ( ) : string Return the UID of the object. If no UID has been set a valid UID will be autogenerated.
hasParseErrors ( )
load ( string $backend_id, Horde_Kolab_Storage_Folder $folder, Horde_Kolab_Storage_Object_Writer $data, Horde_Mime_Part $structure = null ) Loads the object from the backend.
offsetExists ( $offset ) * ArrayAccess methods.
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
save ( Horde_Kolab_Storage_Object_Writer $data ) : boolean | string Store the modified object in the backend.
serialize ( ) : string Serialization.
setContent ( resource $content ) Set the content representing the object data.
setData ( array $data ) Set the object data.
setDriver ( Horde_Kolab_Storage_Driver $driver ) Set the driver for accessing the backend.
unserialize ( string $data ) Unserialization.

보호된 메소드들

메소드 설명
_appendMessage ( Horde_Mime_Part $message, Horde_Mime_Headers $headers ) : boolean | string Append a new message.
_getDriver ( ) : Horde_Kolab_Storage_Driver Return the driver for accessing the backend.
_getFolder ( )
_getMimePartId ( )
addParseError ( $error, $message = '' )
createEnvelope ( ) : Horde_Mime_Part Generates a new MIME messages that will wrap a Kolab groupware object.
createEnvelopeHeaders ( ) : Horde_Mime_Headers Generate the headers for the MIME envelope of a Kolab groupware object.
createFreshKolabPart ( resource $content ) : Horde_Mime_Part Embed the Kolab content into a new MIME Part.

메소드 상세

_appendMessage() 보호된 메소드

Append a new message.
protected _appendMessage ( Horde_Mime_Part $message, Horde_Mime_Headers $headers ) : boolean | string
$message Horde_Mime_Part The message.
$headers Horde_Mime_Headers The message headers.
리턴 boolean | string The return value of the append operation.

_getDriver() 보호된 메소드

Return the driver for accessing the backend.
protected _getDriver ( ) : Horde_Kolab_Storage_Driver
리턴 Horde_Kolab_Storage_Driver The driver.

_getFolder() 보호된 메소드

protected _getFolder ( )

_getMimePartId() 보호된 메소드

protected _getMimePartId ( )

addParseError() 보호된 메소드

protected addParseError ( $error, $message = '' )

create() 공개 메소드

Create a new object in the backend.
public create ( Horde_Kolab_Storage_Folder $folder, Horde_Kolab_Storage_Object_Writer $data, string $type ) : boolean | string
$folder Horde_Kolab_Storage_Folder The folder to retrieve the data object from.
$data Horde_Kolab_Storage_Object_Writer The data writer.
$type string The type of object to be stored.
리턴 boolean | string The return value of the append operation.

createEnvelope() 보호된 메소드

Generates a new MIME messages that will wrap a Kolab groupware object.
protected createEnvelope ( ) : Horde_Mime_Part
리턴 Horde_Mime_Part The new MIME message.

createEnvelopeHeaders() 보호된 메소드

Generate the headers for the MIME envelope of a Kolab groupware object.
protected createEnvelopeHeaders ( ) : Horde_Mime_Headers
리턴 Horde_Mime_Headers The headers for the MIME envelope.

createFreshKolabPart() 보호된 메소드

Embed the Kolab content into a new MIME Part.
protected createFreshKolabPart ( resource $content ) : Horde_Mime_Part
$content resource The Kolab content.
리턴 Horde_Mime_Part The MIME part that encapsules the Kolab content.

generateUid() 공개 메소드

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

getBackendId() 공개 메소드

public getBackendId ( )

getContent() 공개 메소드

Fetch the raw content representing the object data.
public getContent ( ) : resource
리턴 resource The raw object content.

getCurrentContent() 공개 메소드

Return the current content value representing the object data. This call does not attempt to fetch the content from the backend.
public getCurrentContent ( ) : resource
리턴 resource The raw object content.

getData() 공개 메소드

Fetch the object data.
public getData ( ) : array
리턴 array The object data.

getHeaders() 공개 메소드

Return the MIME headers of the object envelope.
public getHeaders ( ) : Horde_Mime_Headers
리턴 Horde_Mime_Headers The MIME headers.

getParseErrors() 공개 메소드

public getParseErrors ( )

getType() 공개 메소드

Return the object type.
public getType ( ) : string
리턴 string The object type.

getUid() 공개 메소드

Return the UID of the object. If no UID has been set a valid UID will be autogenerated.
public getUid ( ) : string
리턴 string The object UID.

hasParseErrors() 공개 메소드

public hasParseErrors ( )

load() 공개 메소드

Loads the object from the backend.
public load ( string $backend_id, Horde_Kolab_Storage_Folder $folder, Horde_Kolab_Storage_Object_Writer $data, Horde_Mime_Part $structure = null )
$backend_id string The object ID within the backend.
$folder Horde_Kolab_Storage_Folder The folder to retrieve the data object from.
$data Horde_Kolab_Storage_Object_Writer The data parser.
$structure Horde_Mime_Part The MIME message structure of the object.

offsetExists() 공개 메소드

* ArrayAccess methods.
public offsetExists ( $offset )

offsetGet() 공개 메소드

public offsetGet ( $offset )

offsetSet() 공개 메소드

public offsetSet ( $offset, $value )

offsetUnset() 공개 메소드

public offsetUnset ( $offset )

save() 공개 메소드

Store the modified object in the backend.
public save ( Horde_Kolab_Storage_Object_Writer $data ) : boolean | string
$data Horde_Kolab_Storage_Object_Writer The data writer.
리턴 boolean | string The return value of the append operation.

serialize() 공개 메소드

Serialization.
public serialize ( ) : string
리턴 string Serialized data.

setContent() 공개 메소드

Set the content representing the object data.
public setContent ( resource $content )
$content resource The object content.

setData() 공개 메소드

Set the object data.
public setData ( array $data )
$data array The object data.

setDriver() 공개 메소드

Set the driver for accessing the backend.
public setDriver ( Horde_Kolab_Storage_Driver $driver )
$driver Horde_Kolab_Storage_Driver The driver.

unserialize() 공개 메소드

Unserialization.
public unserialize ( string $data )
$data string Serialized data.

프로퍼티 상세

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

The object ID within the backend.
protected string $_backend_id
리턴 string

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

The content string representing the object data.
protected resource $_content
리턴 resource

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

The object data.
protected array $_data
리턴 array

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

The driver for accessing the backend.
protected Horde_Kolab_Storage_Driver $_driver
리턴 Horde_Kolab_Storage_Driver

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

The collection of parse errors (if any).
protected array $_errors
리턴 array

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

The folder that holds the object within the backend.
protected string $_folder
리턴 string

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

The MIME headers of the object envelope.
protected Horde_Mime_Headers $_headers
리턴 Horde_Mime_Headers

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

The ID of the MIME part carrying the object data.
protected string $_mime_part_id
리턴 string

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

The message structure.
protected Horde_Mime_Part $_structure
리턴 Horde_Mime_Part

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

The object type.
protected string $_type
리턴 string