Docs For Class XmlObject

Class: XmlObject

Child classes:

Action: An abstraction of an action within an action rule

ActionRule: An abstraction of an action rule consisting of a list of conditions and a list of actions

Condition: An abstraction of a condition within an action rule

Option: An abstraction of radionbutton option

Component: This is the base class for each component. Typically it is not instantiated by itself.

Query: An abstraction of a database query

QueryFilter: An abstraction of a filter expression within a database query

Class Details

[line 9]
Abstraction for a particular XML node within the DOM

This class is never instantiated directly but just extended. It just exists to reduce redundancy in other classes which all need the three methods below. For example, this class is extended in components/button/ActionRule.inc.php

Class Methods

constructor __construct [line 18]

XmlObject __construct(
[mixed
$oDom = NULL], [mixed
$oXmlNode = NULL])

Overridden in child classes as:

ActionRule::__construct(): Construct a new action rule

Condition::__construct(): Construct a new Condition

Component::__construct(): Construct a new component

ComponentDataTable::__construct(): Creates a dataTable component.

ComponentDynamicOutput::__construct(): Creates a dynamicOutput component.

Query::__construct(): Construct a new Query object

QueryFilter::__construct(): Construct a new QueryFilter

[ Top ]

method getDom [line 29]

DOMDocument getDom(
)

Returns a refernce to the DOMDocument that is at the root of this XML object

Tags:

return:	The root node of the XML tree or NULL
static:
access:	public

[ Top ]

method getFirstChildNodeByTagName [line 58]

DOMNode getFirstChildNodeByTagName(
mixed
$sTagName)

Returns a reference to the first child XML node with a particular name

For example, this is used repeatedly in components/button/ActionRule.inc.php

Tags:

return:	a reference to the XML node or NULL
access:	protected

[ Top ]

method getOrCreateChildNodeByTagName [line 76]

DOMNode getOrCreateChildNodeByTagName(
mixed
$sTagName)

Returns a reference to the first child XML node with a particular name.

If it does not exist, a new child node will be created.

Tags:

return:	a reference to the XML node or NULL
access:	protected

[ Top ]

method getXmlNode [line 38]

DOMNode getXmlNode(
)

Returns a reference to the DOMNode of this XML object

Tags:

return:	XML node of this XML object or NULL
access:	public

[ Top ]

method removeAllChildNodesByTagName [line 91]

void removeAllChildNodesByTagName(
string
$sTagName)

Deletes all child nodes that have a particular name

Tags:

access:

protected

Parameters:

string

$sTagName

The name of the nodes to be removed

[ Top ]

method setXmlNode [line 47]

void setXmlNode(
DOMNode
$oXmlNode)

Sets a refernce to the DOMNode.

Tags:

access:

public

Parameters:

DOMNode

$oXmlNode

reference to the new DOMNode

[ Top ]

Documentation generated on Wed, 12 Jan 2005 17:53:24 -0500 by phpDocumentor 1.3.0RC3

Class: XmlObject

Class Overview

Methods

Child classes:

Class Details

Class Methods

constructor __construct [line 18]

method getDom [line 29]

Tags:

method getFirstChildNodeByTagName [line 58]

Tags:

method getOrCreateChildNodeByTagName [line 76]

Tags:

method getXmlNode [line 38]

Tags:

method removeAllChildNodesByTagName [line 91]

Tags:

Parameters:

method setXmlNode [line 47]

Tags:

Parameters: