Signature: setDocumentElement(&$node)

Parameters:

DOMIT_Node node - The node that is to be appended as documentElement. Only a single node can serve as documentElement, so an existing documentElement node will be overwritten.

Returns:

DOMIT_Node - The appended documentElement node.

Example:

The documentElement of a tree is assigned using setDocumentElement:

$mydoc->setDocumentElement($elementNode);

Signature: resolveErrors($truthVal)

Parameters:

boolean truthVal - True if errors are to be resolved.

Example:

Error resolution is turned on:

$mydoc->resolveErrors(true);

Signature: setNamespaceAwareness($truthVal)

Parameters:

boolean truthVal - True if namespaces are to be processed.

Example:

Namespaces are to be processed:

$mydoc->setNamespaceAwareness(true);
$myDoc->loadXML('my.xml', true);

Signature: setConnection($host, $path = '/', $port = 80, $timeout = 0, $user = null, $password = null)

Parameters:

String host - The ip address or domain name of the connection.

String path - The path of the connection.

int port - The port that the connection is listening on.

int timeout - The timeout value for the connection.

String user - The user name, if authentication is required.

String password - The password, if authentication is required.

Example:

A manual HTTP connection is specified:

$xmldoc->setConnection('http://www.engageinteractive.com');

Signature: setAuthorization($user, $password)

Parameters:

String user - The user name.

String password - The password.

Example:

Authorization is specified for the HTTP connection:

$xmldoc->setAuthorization('johndoe', 'xyzzy');

Signature: setProxyConnection($host, $path = '/', $port = 80, $timeout = 0, $user = null, $password = null)

Parameters:

String host - The ip address or domain name of the connection.

String path - The path of the connection.

int port - The port that the connection is listening on.

int timeout - The timeout value for the connection.

String user - The user name, if authentication is required.

String password - The password, if authentication is required.

Example:

A HTTP proxy connection is specified:

$xmldoc->setProxyConnection('http://www.engageinteractive.com');

Signature: setProxyAuthorization($user, $password)

Parameters:

String user - The user name.

String password - The password.

Example:

Authorization is specified for the HTTP connection:

$xmldoc->setProxyAuthorization('johndoe', 'xyzzy');

Signature: getErrorCode()

Returns:

int - The error code.

Example:

The error code is returned:

echo $mydoc->getErrorCode();

Signature: getErrorString()

Returns:

String - The error string.

Example:

The error string is returned:

echo $mydoc->getErrorString();

Signature: expandEmptyElementTags($truthVal, $expandEmptyElementExceptions = false)

Parameters:

boolean truthVal - True if empty element tags are to be expanded.

array expandEmptyElementExceptions - An array of tag name exceptions to the expansion rule.

Example:

Entity tag expansion is turned on, except for br and img tags:

$mydoc->expandEmptyElementTags(true, array('br','img'));

Signature: &appendChild(&$child)

Parameters:

DOMIT_Node child - The node that is to be appended. Only a single node can serve as documentElement, so an existing documentElement node will be overwritten.

Returns:

DOMIT_Node - The appended node.

Example:

The documentElement of a tree is assigned using appendChild:

$mydoc->appendChild($elementNode);

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:

The documentElement node is replaced by a new node:

$myDoc->replaceChild($newDocElem, $oldDocElem);

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:

The documentElement node is removed from the document.

$mydoc->removeNode($docElem);

Signature: &createDocumentFragment()

Returns:

DOMIT_DocumentFragment - The newly created DOMIT_DocumentFragment.

Example:

A new DOMIT_DocumentFragment can be created in the following manner:

$myDocFrag =& $xmldoc->createDocumentFragment();

Signature: &createAttribute($name)

Parameters:

String name - The key of the DOMIT_Attr to be created.

Returns:

DOMIT_Attr - The newly created DOMIT_Attr.

Example:

A new DOMIT_Attr can be created in the following manner:

$myAttr =& $xmldoc->createAttribute("id");

Signature: &createAttributeNS($namespaceURI, $qualifiedName)

Parameters:

String namespaceURI - The namespaceURI of the attribute.

String qualifiedName - The qualifiedName of the attribute.

Returns:

DOMIT_Attr - The newly created DOMIT_Attr.

Example:

A new DOMIT_Attr can be created in the following manner:

$myAttr =& $xmldoc->createAttributeNS("http://www.engageinteractive.com", "ei:description");

Signature: &createElement($tagName)

Parameters:

String tagName - The tagName of the DOMIT_Element to be created.

Returns:

DOMIT_Element - The newly created DOMIT_Element.

Example:

A new DOMIT_Element can be created in the following manner:

$myBook =& $xmldoc->createElement("book");

Signature: &createElementNS($namespaceURI, $qualifiedName)

Parameters:

String namespaceURI - The namespaceURI of the element.

String qualifiedName - The qualifiedName of the element.

Returns:

DOMIT_Element - The newly created DOMIT_Element.

Example:

A new DOMIT_Element can be created in the following manner:

$myBook =& $xmldoc->createElementNS("http://purl.org/dc/elements/1.1", "dc:creator");

Signature: &createTextNode($data)

Parameters:

String data - The text of the DOMIT_TextNode to be created.

Returns:

DOMIT_TextNode - The newly created DOMIT_TextNode.

Example:

A new DOMIT_TextNode can be created in the following manner:

$myBookCritique =& $xmldoc->createTextNode("A really good read.");

Signature: &createCDATASection($data)

Parameters:

String data - The text of the DOMIT_CDATASection to be created.

Returns:

DOMIT_CDATASection - The newly created DOMIT_CDATASection.

Example:

A new DOMIT_CDataSection can be created in the following manner:

$curseWord =& $xmldoc->createCDATASection("&*^%$#@");

Signature: &createComment($text)

Parameters:

String text - The text of the DOMIT_Comment to be created.

Returns:

DOMIT_Comment - The newly created DOMIT_Comment.

Example:

A new DOMIT_Comment can be created in the following manner:

$comment =& new DOMIT_Comment("This is a comment");

Signature: &createProcessingInstruction($target, $data)

Parameters:

String target - The target of the DOMIT_ProcessingInstruction to be created.

String data - The data of the DOMIT_ProcessingInstruction to be created.

Returns:

DOMIT_ProcessingInstruction - The newly created DOMIT_ProcessingInstruction.

Example:

A new DOMIT_ProcessingInstruction can be created in the following manner:

$pi =& $xmldoc->createProcessingInstruction("xml", "version=\"1.0\" encoding=\"iso-8859-1\"");

Signature: &getElementsByTagName($tagName)

Parameters:

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

Returns:

DOMIT_NodeList - The DOMIT_NodeList of found DOMIT_Elements.

Example:

Here, all elements named "poem" that fall under the $poems node are returned as a DOMIT_NodeList:

$poems =& $library->getElementsByTagName("poem");

Signature: &getElementsByTagNameNS($namespaceURI, $localName)

Parameters:

String namespaceURI - The matching namespaceURI, or "*" if all elements are to be returned.

String localName - The matching localName, or "*" if all elements are to be returned.

Returns:

DOMIT_NodeList - The DOMIT_NodeList of found DOMIT_Elements.

Example:

A DOMIT_NodeList of matching elements is returned:

$authors =& $library->getElementsByTagNameNS("http://purl.org/dc/elements/1.1", "creator");

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

Parameters:

String pattern - The query pattern.

int nodeIndex - If a single node is to be returned (rather than the entire NodeList) the index of that node.

Returns:

DOMIT_NodeList - A NodeList or single node that matches the pattern.

Signature: &getElementByID($elementID, $isStrict = true)

Parameters:

String elementID - The id of the matching element.

boolean isStrict - True if XML spec is to be strictly adhered to (only attributes xml:id are considered valid).

Returns:

DOMIT_Element - An element matching the query.

Example:

A matching DOMIT_Element is returned:

$element =& $xmldoc->getElementByID("0231", true);

Signature: parseXML($xmlText, $useSAXY = true, $preserveCDATA = true, $fireLoadEvent = false)

Parameters:

String xmlText - The xml text to be parsed.

boolean useSAXY - false (or omitted) if the Expat parser is to be used, true if SAXY is used. Note that since SAXY is not a C extension as is Expat, there is no question as to its availability. It is also slightly faster than Expat, although possibly not as robust.

boolean preserveCDATA - True (or omitted) to retain CDATASection nodes, false to convert into Text Nodes

boolean fireLoadEvent - false (or omitted) if the onLoad() function is NOT to be called for each node after the DOMIT_Document is created, true if the event is to be triggered.

Example:

The xml string will be parsed using the SAXY parser:

$xmldoc->parseXML("<book><title>Using DOMIT!</title><author>John Heinstein</author></book>", true);

Signature: parseXML_utf8($xmlText, $useSAXY = true, $preserveCDATA = true, $fireLoadEvent = false)

Parameters:

String xmlText - The xml text to be parsed.It will be encoded as UTF-8, so that non US-ASCII characters can be interpreted properly.

boolean useSAXY - false (or omitted) if the Expat parser is to be used, true if SAXY is used. Note that since SAXY is not a C extension as is Expat, there is no question as to its availability. It is also slightly faster than Expat, although possibly not as robust.

boolean preserveCDATA - True (or omitted) to retain CDATASection nodes, false to convert into Text Nodes

boolean fireLoadEvent - false (or omitted) if the onLoad() function is NOT to be called for each node after the DOMIT_Document is created, true if the event is to be triggered.

Example:

The xml string, utf-8 encoded, will be parsed using the SAXY parser:

$xmldoc->parseXML_utf8("<book><title>Using DOMIT!</title><author>John Heinstein</author></book>", true);

Signature: loadXML($fileName, $useSAXY = true, $preserveCDATA = true, $fireLoadEvent = false)

Parameters:

String fileName - The file name (url or local file) containing the xml to be parsed.

boolean useSAXY - false (or omitted) if the Expat parser is to be used, true if SAXY is used. Note that since SAXY is not a C extension as is Expat, there is no question as to its availability. It is also slightly faster than Expat, although possibly not as robust.

boolean preserveCDATA - True (or omitted) to retain CDATASection nodes, false to convert into Text Nodes

boolean fireLoadEvent - false (or omitted) if the onLoad() function is NOT to be called for each node after the DOMIT_Document is created, true if the event is to be triggered.

Returns:

boolean - True if the xml parsed properly.

Example:

The xml string in file myFile.xml will be parsed using the SAXY parser:

$xmldoc->loadXML("http://www.someurl.com/myFile.xml", true);

Signature: loadXML_utf8($fileName, $useSAXY = true, $preserveCDATA = true, $fireLoadEvent = false)

Parameters:

String fileName - The file name (url or local file) containing the xml to be parsed.

boolean useSAXY - false (or omitted) if the Expat parser is to be used, true if SAXY is used. Note that since SAXY is not a C extension as is Expat, there is no question as to its availability. It is also slightly faster than Expat, although possibly not as robust.

boolean preserveCDATA - True (or omitted) to retain CDATASection nodes, false to convert into Text Nodes

boolean fireLoadEvent - false (or omitted) if the onLoad() function is NOT to be called for each node after the DOMIT_Document is created, true if the event is to be triggered.

Returns:

boolean - True if the xml parsed properly.

Example:

The xml string in file myFile.xml will be utf8 encoded and parsed using the SAXY parser:

$xmldoc->loadXML_utf8("http://www.someurl.com/myFile.xml", true);

Signature: getTextFromFile($filename)

Parameters:

String fileName - The file name (url or local file) containing the text to be retrieved.

Returns:

String - The text contained in the specified file.

Example:

The string in file myFile.txt will be retrieved:

$myText = $xmldoc->getTextFromFile("http://www.someurl.com/myFile.txt");

Signature: saveXML($fileName, $normalized=false)

Parameters:

String fileName - The file name (url or local file) to which the XML is to be saved.

String normalized - If set to true, a whitespace formatted representation of the xml will be saved. Default is false.

Returns:

boolean - True if the file is saved properly.

Example:

The current document will be saved as myFile.xml:

$success = $xmldoc->saveXML("http://www.someurl.com/myFile.xml");

Signature: saveXML_utf8($fileName, $normalized=false)

Parameters:

String fileName - The file name (url or local file) to which the XML is to be saved. The string is first encoded as UTF-8, so that non ASCII characters can be interpreted properly.

Returns:

boolean - True if the file is saved properly.

Example:

The current document, utf8 encoded, will be saved as myFile.xml:

$success = $xmldoc->saveXML_utf8("http://www.someurl.com/myFile.xml");

Signature: saveTextToFile($fileName, $text)

Parameters:

String fileName - The file name (url or local file) where the specified text is to be written.

String text - The text to be written to the specified file name.

Returns:

boolean - True if the save is successful.

Example:

The specified string will be saved as myFile.txt:

$success = $xmldoc->saveTextToFile("../myFile.txt", "This is a test");

Signature: parsedBy()

Returns:

String - The name of the parser used to create the document, either "SAXY" or "EXPAT". An empty string is returned if the document is empty.

Example:

The name of the parser is returned:

$myParser = $xmldoc->parsedBy();

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);

Signature: &getNodesByNodeType($type, &$contextNode)

Parameters:

int type - A DOMIT! constant referring to the node type, one of: DOMIT_DOCUMENT_NODE (9), DOMIT_ELEMENT_NODE (1), DOMIT_TEXT_NODE (3), DOMIT_CDATA_SECTION_NODE (4).

DOMIT_Node contextNode - An element or document node from which the search should begin.

Returns:

DOMIT_NodeList - A DOMIT_NodeList containing the found nodes.

Example:

All elements in the document will be returned.

$allElements =& $xmldoc->getNodesByNodeType(DOMIT_ELEMENT_NODE, $xmldoc);

Signature: &getNodesByNodeValue($value, &$contextNode)

Parameters:

String value - The text to search for in any text/cdata nodes that are encountered.

DOMIT_Node contextNode - An element or document node from which the search should begin.

Returns:

array - A DOMIT_NodeList containing the found nodes.

Example:

All text nodes in the document containing the string "Richard Thompson" will be returned.

$textNodes =& $cdCollectionDoc->getNodesByNodeValue("Richard Thompson", $cdCollectionDoc);

Signature: getText()

Returns:

String - The text contained in the children of the specified node.

Example:

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

$allDocmentText = $xmldoc->getText();

Signature: getXMLDeclaration()

Returns:

String - The text of the xml declaration if one exists for the current document.

Example:

The xml declaration will be returned.

$xmldec = $xmldoc->getXMLDeclaration();

Signature: getDocType()

Returns:

String - The text of the doctype if one exists for the current document.

Example:

The doctype will be returned.

$doctype= $xmldoc->getDocType();

Signature: &getDOMImplementation()

Returns:

DOMIT_DOMImplementation - The DOMIT_DOMImplementation reference.

Example:

A reference to the DOMIT_DOMImplementation will be returned and used to determine compliance with the DOM HTML spec.

$domRef =& $xmldoc->getDOMImplementation();
$supportsHTML = $domRef->hasFeature("HTML")

Signature: getVersion()

Returns:

String - The current version of DOMIT!

Example:

Returns the current version of DOMIT!

$currentVersion = $xmldoc->getVersion();

Signature: appendEntityTranslationTable($table)

Parameters:

Array table - A list of entity mappings in the format: array('&amp;' => '&');

Signature: toArray()

Returns:

array - An array representing the xml document.

Example:

Prints out an array representing the xml document.

print_r($xmldoc->toArray());

Signature: toString($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 - An unformatted (single line, no whitespace) string representation of the document and all children.

Example:

An unformatted string representation of the xml document will be printed here:

echo $myDoc->toString(true);