Overview

Packages

  • Kolab
    • Format

Classes

  • Horde_Kolab_Format_Date
  • Horde_Kolab_Format_Decorator_Base
  • Horde_Kolab_Format_Decorator_Memory
  • Horde_Kolab_Format_Decorator_Timed
  • Horde_Kolab_Format_Exception
  • Horde_Kolab_Format_Exception_InvalidRoot
  • Horde_Kolab_Format_Exception_MissingUid
  • Horde_Kolab_Format_Exception_MissingValue
  • Horde_Kolab_Format_Exception_ParseError
  • Horde_Kolab_Format_Factory
  • Horde_Kolab_Format_Xml
  • 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_Helper
  • Horde_Kolab_Format_Xml_Hprefs
  • Horde_Kolab_Format_Xml_Note
  • Horde_Kolab_Format_Xml_Parser
  • Horde_Kolab_Format_Xml_Task
  • Horde_Kolab_Format_Xml_Type_AddressType
  • Horde_Kolab_Format_Xml_Type_AttendeeRole
  • Horde_Kolab_Format_Xml_Type_AttendeeStatus
  • Horde_Kolab_Format_Xml_Type_AutomaticDate
  • Horde_Kolab_Format_Xml_Type_AutomaticDate_V1
  • Horde_Kolab_Format_Xml_Type_Base
  • Horde_Kolab_Format_Xml_Type_Boolean
  • Horde_Kolab_Format_Xml_Type_Boolean_True
  • Horde_Kolab_Format_Xml_Type_Color
  • Horde_Kolab_Format_Xml_Type_Color_Background
  • Horde_Kolab_Format_Xml_Type_Color_Foreground
  • Horde_Kolab_Format_Xml_Type_Composite
  • Horde_Kolab_Format_Xml_Type_Composite_Address
  • Horde_Kolab_Format_Xml_Type_Composite_Attendee
  • Horde_Kolab_Format_Xml_Type_Composite_Name
  • Horde_Kolab_Format_Xml_Type_Composite_Phone
  • Horde_Kolab_Format_Xml_Type_Composite_Recurrence
  • Horde_Kolab_Format_Xml_Type_Composite_Recurrence_V1
  • Horde_Kolab_Format_Xml_Type_Composite_SimplePerson
  • Horde_Kolab_Format_Xml_Type_CreationDate
  • Horde_Kolab_Format_Xml_Type_CreationDate_V1
  • Horde_Kolab_Format_Xml_Type_Date
  • Horde_Kolab_Format_Xml_Type_Date_V1
  • Horde_Kolab_Format_Xml_Type_DateTime
  • Horde_Kolab_Format_Xml_Type_DateTime_V1
  • Horde_Kolab_Format_Xml_Type_EventDate
  • Horde_Kolab_Format_Xml_Type_EventDate_V1
  • Horde_Kolab_Format_Xml_Type_Integer
  • Horde_Kolab_Format_Xml_Type_ModificationDate
  • Horde_Kolab_Format_Xml_Type_Multiple
  • Horde_Kolab_Format_Xml_Type_Multiple_Address
  • Horde_Kolab_Format_Xml_Type_Multiple_Attendee
  • Horde_Kolab_Format_Xml_Type_Multiple_Boolean
  • Horde_Kolab_Format_Xml_Type_Multiple_Date
  • Horde_Kolab_Format_Xml_Type_Multiple_Phone
  • Horde_Kolab_Format_Xml_Type_Multiple_SimplePerson
  • Horde_Kolab_Format_Xml_Type_Multiple_String
  • Horde_Kolab_Format_Xml_Type_PhoneType
  • Horde_Kolab_Format_Xml_Type_PrefsApplication
  • Horde_Kolab_Format_Xml_Type_ProductId
  • Horde_Kolab_Format_Xml_Type_RecurrenceInterval
  • Horde_Kolab_Format_Xml_Type_RecurrenceRange
  • Horde_Kolab_Format_Xml_Type_RecurrenceRange_V1
  • Horde_Kolab_Format_Xml_Type_Root
  • Horde_Kolab_Format_Xml_Type_Sensitivity
  • Horde_Kolab_Format_Xml_Type_String
  • Horde_Kolab_Format_Xml_Type_String_Empty
  • Horde_Kolab_Format_Xml_Type_String_MaybeMissing
  • Horde_Kolab_Format_Xml_Type_TaskCompletion
  • Horde_Kolab_Format_Xml_Type_TaskPriority
  • Horde_Kolab_Format_Xml_Type_TaskStatus
  • Horde_Kolab_Format_Xml_Type_Uid
  • Horde_Kolab_Format_Xml_Type_XmlAppend

Interfaces

  • Horde_Kolab_Format
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_Format_Xml_Helper

Provides DOM utility methods.

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

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

Package: Kolab\Format
Category: Kolab
License: LGPL
Author: Gunnar Wrobel wrobel@pardus.de
Since: Horde_Kolab_Format 1.1.0
Link: http://www.horde.org/libraries/Horde_Kolab_Format
Located at Horde/Kolab/Format/Xml/Helper.php
Methods summary
public
# __construct( DOMDocument $xmldoc )

Constructor

Constructor

Parameters

$xmldoc
The XML document this object works with.
public string|null
# fetchNodeValue( DOMNode $node )

Fetch the value of a node.

Fetch the value of a node.

Parameters

$node
Retrieve the text value for this node.

Returns

string|null
The text value or null if no value was identified.
public DOMNode
# storeNewNodeValue( DOMNode $parent_node, string $name, string $value )

Store a value as a new text node.

Store a value as a new text node.

Parameters

$parent_node
Attach the new node to this parent.
$name
Name of the new child node.
$value
Text value of the new child node.

Returns

DOMNode
The new child node.
public DOMNode
# createNodeValue( DOMNode $parent_node, string $name, string $value )

Store a value as a new text node.

Store a value as a new text node.

Parameters

$parent_node
Attach the new node to this parent.
$name
Name of the new child node.
$value
Text value of the new child node.

Returns

DOMNode
The new child node.
public DOMNode
# appendXml( DOMNode $parent_node, string $xml )

Append an XML snippet.

Append an XML snippet.

Parameters

$parent_node
Attach the XML below this parent.
$xml
The XML to append.

Returns

DOMNode
The new child node.
public DOMNode
# createNewNode( DOMNode $parent_node, string $name )

Create a new node.

Create a new node.

Parameters

$parent_node
Attach the new node to this parent.
$name
Name of the new child node.

Returns

DOMNode
The new child node.
public null
# replaceFirstNodeTextValue( DOMNode $node, string $value )

Store a value as a new text node.

Store a value as a new text node.

Parameters

$node
Replace the text value of this node.
$value
Text value of the new child node.

Returns

null
public DOMNode|false
# findNode( string $query )

Return a single named node matching the given XPath query.

Return a single named node matching the given XPath query.

Parameters

$query
The query.

Returns

DOMNode|false
The named DOMNode or empty if no node was found.
public DOMNode|false
# findNodeRelativeTo( string $query, DOMNode $context )

Return a single named node below the given context matching the given XPath query.

Return a single named node below the given context matching the given XPath query.

Parameters

$query
The query.
$context
Search below this node.

Returns

DOMNode|false
The named DOMNode or empty if no node was found.
public DOMNodeList
# findNodes( string $query )

Return all nodes matching the given XPath query.

Return all nodes matching the given XPath query.

Parameters

$query
The query.

Returns

DOMNodeList
The list of DOMNodes.
public DOMNodeList
# findNodesRelativeTo( string $query, DOMNode $context )

Return all nodes matching the given XPath query.

Return all nodes matching the given XPath query.

Parameters

$query
The query.
$context
Search below this node.

Returns

DOMNodeList
The list of DOMNodes.
public null
# removeNodes( DOMNode $parent_node, string $name )

Remove named nodes from a parent node.

Remove named nodes from a parent node.

Parameters

$parent_node
The parent node.
$name
The name of the children to be removed.

Returns

null
public string
# __toString( )

Output the document as XML string.

Output the document as XML string.

Returns

string
The XML output.
API documentation generated by ApiGen