Class Horde_Kolab_Format_Xml

Kolab XML to array hash converter.

For implementing a new format type you will have to inherit this class and provide a _load/_save function.

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

Horde_Kolab_Format_Xml implements Horde_Kolab_Format

Direct known subclasses

Horde_Kolab_Format_Xml_Annotation, Horde_Kolab_Format_Xml_Contact, Horde_Kolab_Format_Xml_Distributionlist, Horde_Kolab_Format_Xml_Envelope, Horde_Kolab_Format_Xml_Event, Horde_Kolab_Format_Xml_Hprefs, Horde_Kolab_Format_Xml_Note, Horde_Kolab_Format_Xml_Task

Package: Kolab\Format
Category: Kolab
License: LGPL 2.1
Author: Thomas Jarosch thomas.jarosch@intra2net.com
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://www.horde.org/libraries/Horde_Kolab_Format
Located at Horde/Kolab/Format/Xml.php

Methods summary
`public`	# `__construct( Horde_Kolab_Format_Xml_Parser $parser, Horde_Kolab_Format_Factory $factory, array $params = null )` Constructor Constructor Parameters `$parser` The XML parser. `$factory` <p>The factory for helper objects.</p> `$params` Any additional options.
`public array`	# `load( resource $xml, array $options = array() )` Load an object based on the given XML stream. The stream may only contain UTF-8 data. Load an object based on the given XML stream. The stream may only contain UTF-8 data. Parameters `$xml` The XML stream of the message. `$options` Additional options when parsing the XML. - relaxed: Relaxed error checking (<span class="php-keyword1">default</span>: <span class="php-keyword1">false</span>) Returns `array` The data array representing the object. Throws `Horde_Kolab_Format_Exception` If parsing the XML data failed. Implementation of `Horde_Kolab_Format::load()`
`public resource`	# `save( array $object, array $options = array() )` Convert the data to a XML stream. Strings contained in the data array may only be provided as UTF-8 data. Convert the data to a XML stream. Strings contained in the data array may only be provided as UTF-8 data. Parameters `$object` The data array representing the object. `$options` Additional options when writing the XML. <pre>- previos: The previous XML text (<span class="php-keyword1">default</span>: <span class="php-keyword1">empty</span> string) - relaxed: Relaxed error checking (<span class="php-keyword1">default</span>: <span class="php-keyword1">false</span>)</pre> Returns `resource` The data as XML stream. Throws `Horde_Kolab_Format_Exception` If converting the data to XML failed. Implementation of `Horde_Kolab_Format::save()`
`public integer`	# `getVersion( )` Return the API version of the data structures that are being used for in- and output. Return the API version of the data structures that are being used for in- and output. Returns `integer` The version number; Since Horde_Kolab_Format 1.1.0

Constants summary
`string`	`PRODUCT_ID` Defines a XML value that should get a default value if missing Defines a XML value that should get a default value if missing	# `__CLASS__`
`integer`	`VALUE_DEFAULT` Defines a XML value that should get a default value if missing Defines a XML value that should get a default value if missing	# `0`
`integer`	`VALUE_MAYBE_MISSING` Defines a XML value that may be missing Defines a XML value that may be missing	# `1`
`integer`	`VALUE_NOT_EMPTY` Defines a XML value that may not be missing Defines a XML value that may not be missing	# `2`
`integer`	`VALUE_CALCULATED` Defines a XML value that will be calculated by its own function Defines a XML value that will be calculated by its own function	# `3`
`string`	`TYPE_STRING` Defines a XML value as string type Defines a XML value as string type	# `'Horde_Kolab_Format_Xml_Type_String'`
`string`	`TYPE_INTEGER` Defines a XML value as integer type Defines a XML value as integer type	# `'Horde_Kolab_Format_Xml_Type_Integer'`
`string`	`TYPE_BOOLEAN` Defines a XML value as boolean type Defines a XML value as boolean type	# `'Horde_Kolab_Format_Xml_Type_Boolean'`
`string`	`TYPE_DATE` Defines a XML value as date type Defines a XML value as date type	# `'Horde_Kolab_Format_Xml_Type_Date'`
`string`	`TYPE_DATETIME` Defines a XML value as datetime type Defines a XML value as datetime type	# `'Horde_Kolab_Format_Xml_Type_DateTime'`
`string`	`TYPE_DATE_OR_DATETIME` Defines a XML value as date or datetime type Defines a XML value as date or datetime type	# `'Horde_Kolab_Format_Xml_Type_DateTime'`
`string`	`TYPE_COLOR` Defines a XML value as color type Defines a XML value as color type	# `'Horde_Kolab_Format_Xml_Type_Color'`
`string`	`TYPE_COMPOSITE` Defines a XML value as composite value type Defines a XML value as composite value type	# `'Horde_Kolab_Format_Xml_Type_Composite'`
`string`	`TYPE_MULTIPLE` Defines a XML value as array type Defines a XML value as array type	# `'Horde_Kolab_Format_Xml_Type_Multiple'`
`string`	`TYPE_XML` Defines a XML value as raw XML Defines a XML value as raw XML	# `'Horde_Kolab_Format_Xml_Type_XmlAppend'`
`string`	`TYPE_ROOT` Represents the Kolab format root node Represents the Kolab format root node	# `'Horde_Kolab_Format_Xml_Type_Root'`

Constants inherited from Horde_Kolab_Format
`VERSION`

Packages

Classes

Interfaces

Class Horde_Kolab_Format_Xml

Direct known subclasses

Parameters

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Since