Documentation

Horde_Kolab_Format

The Horde_Kolab_Format:: interface defines the basic properties of a Kolab format handler.

Copyright 2007-2010 Klarälvdalens Datakonsult AB Copyright 2010-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

link
http://www.horde.org/libraries/Horde_Kolab_Format

Table of Contents

VERSION  = '@version@'
The package version
load()  : array<string|int, mixed>
Load an object based on the given XML stream. The stream may only contain UTF-8 data.
save()  : resource
Convert the data to a XML stream. Strings contained in the data array may only be provided as UTF-8 data.

Constants

VERSION

The package version

public mixed VERSION = '@version@'

Methods

load()

Load an object based on the given XML stream. The stream may only contain UTF-8 data.

public load(resource $xml[, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
$xml : resource

The XML stream of the message.

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

Additional options when parsing the XML. See the concrete parsers for additional information.

Tags
throws
Horde_Kolab_Format_Exception
Return values
array<string|int, mixed>

The data array representing the object.

save()

Convert the data to a XML stream. Strings contained in the data array may only be provided as UTF-8 data.

public save(array<string|int, mixed> $object[, array<string|int, mixed> $options = array() ]) : resource
Parameters
$object : array<string|int, mixed>

The data array representing the object.

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

Additional options when writing the XML. See the concrete parsers for additional information.

Tags
throws
Horde_Kolab_Format_Exception
Return values
resource

The data as XML stream.

Search results