Documentation

Horde_Kolab_Storage_Object_Writer_Format extends Horde_Kolab_Storage_Object_Writer
in package

Converts between Kolab MIME parts and data arrays.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$_factory  : Horde_Kolab_Format_Factory
The format parser factory.
$_formats  : array<string|int, mixed>
Holds a parser instance per object type.
$_params  : array<string|int, mixed>
Additional parameters for the format parsers.
__construct()  : mixed
Condtructor.
load()  : mixed
Convert the object content into a data structure and update the object accordingly.
save()  : string
Return the object data in a form that it can be stored in the backend.
_getParser()  : mixed

Properties

$_factory

The format parser factory.

private Horde_Kolab_Format_Factory $_factory

$_formats

Holds a parser instance per object type.

private array<string|int, mixed> $_formats

$_params

Additional parameters for the format parsers.

private array<string|int, mixed> $_params

Methods

__construct()

Condtructor.

public __construct(Horde_Kolab_Format_Factory $factory[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$factory : Horde_Kolab_Format_Factory

The parser factory.

$params : array<string|int, mixed> = array()

Additional parameters for the format parsers.

Return values
mixed —

load()

Convert the object content into a data structure and update the object accordingly.

public load(resource $content, Horde_Kolab_Storage_Object $object) : mixed
Parameters
$content : resource

The raw content from the object.

$object : Horde_Kolab_Storage_Object

The object that should receive the parsed data.

Return values
mixed —

save()

Return the object data in a form that it can be stored in the backend.

public save(Horde_Kolab_Storage_Object $object) : string
Parameters
$object : Horde_Kolab_Storage_Object

The object that should receive the parsed data.

Return values
string —

The encoded object data, ready to be written into the backend.

_getParser()

private _getParser(mixed $type) : mixed
Parameters
$type : mixed
Return values
mixed —

Search results