PHP Класс Horde_Kolab_Storage_Object, horde

См. ссылку: http://pear.horde.org/index.php?package=Kolab_Storage
Автор: Gunnar Wrobel ([email protected])
Наследование: implements ArrayAccess, implements Serializable
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_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