Public Constants

DOMIT_INCLUDE_PATH

The absolute path to the DOMIT! source files.

Type: String

Value: ./

DOMIT_VERSION

The current version of DOMIT.

Type: double

Value: 0.91

DOMIT_ELEMENT_NODE

The nodeType for a DOMIT_Element node.

Type: int

Value: 1

DOMIT_ATTRIBUTE_NODE

The nodeType for a DOMIT_Attr node.

Type: int

Value: 2

DOMIT_TEXT_NODE

The nodeType for a DOMIT_TextNode node.

Type: int

Value: 3

DOMIT_CDATA_SECTION_NODE

The nodeType for a DOMIT_CDATASection node.

Type: int

Value: 4

DOMIT_ENTITY_REFERENCE_NODE

The nodeType for a DOMIT_EntityReference node.

Type: int

Value: 5

DOMIT_ENTITY_NODE

The nodeType for a DOMIT_Entity node.

Type: int

Value: 6

DOMIT_PROCESSING_INSTRUCTION_NODE

The nodeType for a DOMIT_ProcessingInstruction node.

Type: int

Value: 7

DOMIT_COMMENT_NODE

The nodeType for a DOMIT_Comment node.

Type: int

Value: 8

DOMIT_DOCUMENT_NODE

The nodeType for a DOMIT_Document node.

Type: int

Value: 9

DOMIT_DOCUMENT_TYPE_NODE

The nodeType for a DOMIT_DocumentType node.

Type: int

Value: 10

DOMIT_DOCUMENT_FRAGMENT_NODE

The nodeType for a DOMIT_DocumentFragment node.

Type: int

Value: 11

DOMIT_NOTATION_NODE

The nodeType for a DOMIT_Notation node.

Type: int

Value: 7

Public Fields

nodeName

The name of the current node.

For DOMIT_Document, nodeName is #document.
For DOMIT_Element, nodeName is the name of the tag.
For DOMIT_Attr, nodeName is the attribute key.
For DOMIT_TextNode, nodeName is #text.
For DOMIT_CDATASection, nodeName is #cdata-section
For DOMIT_DocumentFragment, nodeName is #document-fragment.
For DOMIT_Comment, nodeName is #comment.
For DOMIT_ProcessingInstruction, nodeName is the target of the instruction.
For DOMIT_DocumentType, nodeName is the name of the doctype.

Type: String

nodeValue

The value of the current node.

For DOMIT_TextNode and DOMIT_CDATASection, this represents the text contained in the node.
For DOMIT_Attr, this represents the value of the attribute.
For DOMIT_ProcessingInstruction, this represents the data segment of the node.
For DOMIT_Comment, this represents the comment text.
Otherwise, the value is null.

Type: String

nodeType

An integer representing the type of the current node.

For DOMIT_Element, nodeType is 1.
For DOMIT_Attr, nodeType is 2.
For DOMIT_TextNode, nodeType is 3.
For DOMIT_CDATASection, nodeType is 4.
For DOMIT_ProcessingInstruction, nodeType is 7.
For DOMIT_Comment, nodeType is 8.
For DOMIT_Document, nodeType is 9.
For DOMIT_DocumentType, nodeType is 10.
For DOMIT_DocumentFragment, nodeType is 11.

Type: int

parentNode

A reference to the node of which the current node is a child. For a DOMIT_Document node, this value is null.

Type: DOMIT_Node

childNodes

An array of node references of which the current node is parent. Null if the current node has no children.

Type: array

firstChild

A reference to the first node in the childNodes list. Null if the current node has no children.

Type: DOMIT_Node

lastChild

A reference to the last node in the childNodes list. Null if the current node has no children.

Type: DOMIT_Node

previousSibling

A reference to the node prior to the current node in the childNodes list. Null if the current node is the first child.

Type: DOMIT_Node

nextSibling

A reference to the node after the current node in the childNodes list. Null if the current node is the last child.

Type: DOMIT_Node

attributes

A list of key / value pairs. Only valid for a DOMIT_Element node. Null if no attributes exist.

Type: array

ownerDocument

A reference to the DOMIT_Document. Null if the node has not yet been added to the document.

Type: DOMIT_Document

namespaceURI

A URI that identifies the XML namespace to which the node belongs.

Type: String

prefix

The namespace prefix for the node.

Type: String

localName

The local name of the node.

Type: String

childCount

The number of children a node has.

Type: int

Public Methods

insertBefore

Inserts node $newChild before $refChild in the childNodes of $this. If $refChild does not exist, $newChild is appended to the node chain.

Signature: &insertBefore(&$newChild, &$refChild)

Parameters:

DOMIT_Node newChild - The new node to be added

DOMIT_Node refChild - The existing node before which the new node will be added

Returns:

DOMIT_Node - A reference to the new node being added.

Example:

The following example inserts a "Book" node named $goodNovel before another named $okNovel in a childNodes list named $bestSellers.

$bestSellers->insertBefore($goodNovel, $okNovel);

replaceChild

Replaces node $oldChild with $newChild.

Signature: replaceChild(&$newChild, &$oldChild)

Parameters:

DOMIT_Node newChild - The new node that is to replace the old node.

DOMIT_Node oldChild - The old node that is to be replaced by the new node.

Returns:

DOMIT_Node - The new node $newChild, or false if $oldChild does not exist.

Example:

An old $userProfile node is replaced by a new node:

$userProfile->replaceChild($newProfile, $oldProfile);

removeChild

Removes the specified node from the document.

Signature: &removeChild(&$oldChild)

Parameters:

DOMIT_Node oldChild - The node that is to be removed.

Returns:

DOMIT_Node - The deleted node $oldChild, or false if $oldChild does not exist.

Example:

Node $unpopularNovel is removed from the $bestSellers parent node.

$bestSellers->removeNode($unpopularNovel);

appendChild

Appends the specified node to the childNodes list.

Signature: appendChild(&$child)

Parameters:

DOMIT_Node child - The node that is to be appended. If the parent node is of type DOMIT_Document, only a single node can be appended.

Returns:

DOMIT_Node - The appended node, or false in the case of DOMIT_TextNode and DOMIT_CDATASection subclasses.

Example:

A new node, $brocolli, is appended to the $myGroceryList parent node.

$myGroceryList->appendChild($brocolli);

hasChildNodes

Determines whether a node has any children.

Signature: hasChildNodes()

Returns:

boolean - True if the node has children, false if not.

Example:

The following example checks the $cookieJar node to see if it has any children (cookies!).

$isCookieJarEmpty = $cookieJar->hasChildNodes();

normalize

Collapses all adjacent DOMIT_TextNode or DOMIT_CDATASection nodes in the element subtree.

Signature: normalize()

Example:

All adjacent text nodes in the subtree of the xml document are collapsed:

$xmldoc->normalize();

cloneNode

Returns a copy of the specified node, and if $deep is set to true, all nodes below it in the hierarchy.

Signature: &cloneNode($deep)

Parameters:

boolean deep - True if the children below the cloned node are also to be cloned.

Returns:

DOMIT_Node - The cloned node, with a clone of all subnodes if $deep is set to true.

Example:

In the following example, a node named $styleTemplate is cloned, presumably so the user can create a new style based on the characteristics of the original node.

$newStyle =& styleTemplate->cloneNode(false);

selectNodes

Applies the specified XPath expression. NOT YET IMPLEMENTED, BUT WILL BE SOON!

Signature: &selectNodes($pattern)

Parameters:

String pattern - The XPath expression to be parsed.

Returns:

DOMIT_NodeList - An list of DOMIT_Nodes described by the XPath expression.

Example:

The first "param" element found with a parent named "params" is returned:

$myNodeList =& $someNode->selectNodes("//params/param[1]");

getElementsByPath

Retrieves an element or DOMIT_NodeList of elements corresponding to the specified "path"-like expression. Relative paths (which do not start with "/"), absolute paths (which start with "/") , and variable paths (which start with "//") are allowed. For more information, please see the DOMIT! Tutorial. For more complex patterns, please see the selectNodes method.

Signature: &getElementsByPath($pattern, $nodeIndex = 0)

Parameters:

String pattern - The path-like pattern specifying the elements(s) to be returned.

int nodeIndex - If more than one element matches the specified pattern, setting nodeIndex will return a single node from these possibilities. This is a one-based index.

Returns:

Domit_Node - A DOMIT_NodeList of DOMIT_Nodes, or a single DOMIT_Node, described by the expression.

Example:

The first "param" element found with a parent named "params" is returned:

$myNode =& $xmlDoc->getElementsByPath("//params/param", 1);

getText

Returns the text contained in all DOMIT_TextNodes and DOMIT_CDataSections that are children of the specified starting node

Signature: getText()

Example:

All text and cdata nodes in the document will be concatenated and returned.

$allDocmentText = $xmldoc->getText();

isSupported

Indicates whether the specified feature is supported by the DOM implementation and this node.

Signature: isSupported($feature, $version = null)

Parameters:

String feature - The feature.

String version - The version of the DOM implementation.

Example:

Queries whether HTML DOM is supported.

echo $myDoc->isSupported('HTML', '2.0');

onLoad

A function called immediately after the DOM document has been generated. Useful for initializing nodes derived from the standard DOMIT nodes. This method must be overridden! See loadXML and saveXML for more information on how to invoke this method.

Signature: onLoad()

forHTML

Outputs <pre> formatted text that has had htmlEntities() applied.

Signature: forHTML($text, $doPrint = false)

Parameters:

String text - The text to be output.

String doPrint - True if output should be dumped to the browser, false if it should just be returned. Default is false.

Returns:

String - The resulting formatted text.

toArray

Returns an array representation of the xml document.

Signature: toArray()

Returns:

array - An array representing the xml document.

toNormalizedString

Returns a readable representation of the xml document. Note that the class DOMIT_Utilities is required for this function.

Signature: toNormalizedString($htmlSafe = false, $subEntities=false)

Parameters:

boolean htmlSafe - If true, returns an html formatted representation of the string.

boolean subEntities - True if illegal xml characters in text nodes and attributes should be converted to entities.

Returns:

String - A readable representation of the xml document.

Example:

A normalized representation of the xml document is returned, formatted for display in a browser:

echo $myDoc->toNormalizedString(true);

Private Methods

_constructor

Called by subclasses of DOMIT_Node to initialize fields in the superclass.

Signature: _constructor()

getChildNodeIndex

Searches for and returns the position of the specified child node in the childNodes list.

Signature: getChildNodeIndex(&$arr, &$child)

Parameters:

array arr - A reference to the childNodes list.

DOMIT_Node child - The node to search for in the childNodes list.

Returns:

int - The index of $child in the childNodes array, or -1 if it is not found.

Example:

In the following example, the index of node $myAlbum in parent node $albums is returned:

$index = $albums->getChildNodeIndex($albums->childNodes, $myAlbum);

getNamedElements

A recursive method called by getElementsByTagsName to traverse the document and construct a DOMIT_NodeList of elements of name $tagName that are present.

Signature: getNamedElements(&$nodeList, $tagName)

Parameters:

DOMIT_NodeList nodeList - The DOMIT_NodeList in which the DOMIT_Element references are placed.

String tagName - The tag name of the DOMIT_Elements to be searched for, or "*" if all child elements are to be returned.

Example:

All elements in the document tree named "title" are placed in the $nodeList variable.

require_once("xml_domit_nodemaps.php");
$nodeList =& new DOMIT_NodeList();
$this->documentElement->getNamedElements($nodeList, "title");

setOwnerDocument

Sets the ownerDocument property of all document nodes to the specified root node.

Signature: setOwnerDocument(&$rootNode)

Parameters:

DOMIT_Element rootNode - A reference to the ownerDocument node.

nvl

Tests whether a reference is null. The specified default value is returned if the reference is null. The reference is returned if it is not null.

Signature: &nvl(&$value,$default)

Parameters:

Object value - The reference to be tested for a null value.

Object default - The default value to be returned if the reference is null.

Returns:

Object - Either $value if it is not null, or $default it $value is null.

Example:

A custom menu node is returned if one exists; otherwise the default menu is returned:

$myMenu =& nvl($myCustomMenu, $defaultMenu);

getTypedNodes

Adds all child nodes of the specified nodeType to the NodeList (not present in DOMIT_Lite).

Signature: getTypedNodes(&$nodeList, $type)

Parameters:

DOMIT_NodeList nodeList - The NodeList containing any found nodes.

int type - The nodeType of the nodes to be found.

getValuedNodes

Adds all child nodes of the specified nodeValue to the NodeList (not present in DOMIT_Lite).

Signature: getValuedNodes(&$nodeList, $value)

Parameters:

DOMIT_NodeList nodeList - The NodeList containing any found nodes.

String value - The nodeValue of the nodes to be found.

clearReferences

Clears previousSibling, nextSibling, and parentNode references from a node that has been removed.

Signature: clearReferences()

Documentation generated by ClassyDoc, using the DOMIT! and SAXY parsers.
Please visit Engage Interactive to download free copies.