Documentation

Horde_Kolab_Format_Xml_Parser
in package

Handles parsing the provided XML input.

Copyright 2007-2009 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

$_document  : DOMDocument
The XML parser.
__construct()  : mixed
Constructor.
getDocument()  : DOMDocument
Simply return the DOMDocument without parsing any data.
parse()  : DOMDocument
Load an object based on the given XML string.
_parseXml()  : DOMDocument
Parse the XML string. The root node is returned on success.

Properties

$_document

The XML parser.

private DOMDocument $_document

Methods

__construct()

Constructor.

public __construct(DOMDocument $document) : mixed
Parameters
$document : DOMDocument

The XML parser.

Return values
mixed

getDocument()

Simply return the DOMDocument without parsing any data.

public getDocument() : DOMDocument
Return values
DOMDocument

The DOM document.

parse()

Load an object based on the given XML string.

public parse(string $input[, array<string|int, mixed> $options = array() ]) : DOMDocument
Parameters
$input : string

The XML of the message as string.

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

Additional options when parsing the XML.

- relaxed: Relaxed error checking (default: false)
Tags
throws
Horde_Kolab_Format_Exception

If parsing the XML data failed.

Return values
DOMDocument

The DOM document.

_parseXml()

Parse the XML string. The root node is returned on success.

private _parseXml(string $input[, array<string|int, mixed> $options = array() ]) : DOMDocument
Parameters
$input : string

The XML of the message as string.

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

Additional options when parsing the XML.

Tags
throws
Horde_Kolab_Format_Exception

If parsing the XML data failed.

Return values
DOMDocument

The DOM document.

Search results