|
|
 |
XXVII. DOM Functions
The DOM extension is the replacement for the
DOM XML extension from PHP 4.
The extension still contains many old functions, but they should no
longer be used. In particular, functions that are not object-oriented
should be avoided.
The extension allows you to operate on an XML document with the DOM API.
There is no installation needed to use these
functions; they are part of the PHP core.
The API of the module follows the DOM Level 2 standard as closely
as possible. Consequently, the API is fully object-oriented.
It is a good idea to have the DOM standard available when
using this module.
This module defines a number of classes, which are explained in the
following tables. Classes with an equivalent in the DOM standard are
named DOMxxx.
Extends DOMNode. The DOMAttr
interface represents an attribute in an DOMElement object.
Table 1. | Name | Type | Read-only | Description |
|---|
| name | string | yes | The name of the attribute | | ownerElement | DOMElement | yes | The element which contains the attribute | | schemaTypeInfo | bool | yes | Not implemented yet, always return TRUE | | specified | bool | yes | Not implemented yet, always return TRUE | | value | string | no | The value of the attribute |
Extends DOMNode.
Table 2. | Name | Type | Read-only | Description |
|---|
| data | string | no | The contents of the node | | length | int | yes | The length of the contents |
Extends DOMCharacterData.
Extends DOMNode.
Table 3. | Name | Type | Read-only | Description |
|---|
| actualEncoding | string | yes | | | config | DOMConfiguration | yes | | | doctype | DOMDocumentType | yes |
The Document Type Declaration associated with this document.
| | documentElement | DOMElement | yes |
This is a convenience attribute that allows direct access to the
child node that is the document element of the document.
| | documentURI | string | no |
The location of the document or NULL if undefined.
| | encoding | string | no | | | formatOutput | bool | no | | | implementation | DOMImplementation | yes |
The DOMImplementation object that handles
this document.
| | preserveWhiteSpace | bool | no | Do not remove redundant white space. Default to TRUE. | | recover | bool | no | | | resolveExternals | bool | no |
Set it to TRUE to load external entities from a doctype
declaration. This is useful for including character entities in
your XML document.
| | standalone | bool | no | | | strictErrorChecking | bool | no | Throws DOMException on errors. Default to TRUE. | | substituteEntities | bool | no | | | validateOnParse | bool | no | Loads and validates against the DTD. Default to FALSE. | | version | string | no | | | xmlEncoding | string | yes |
An attribute specifying, as part of the XML declaration, the
encoding of this document. This is NULL when unspecified or when it
is not known, such as when the Document was created in memory.
| | xmlStandalone | bool | no |
An attribute specifying, as part of the XML declaration, whether
this document is standalone. This is FALSE when unspecified.
| | xmlVersion | string | no |
An attribute specifying, as part of the XML declaration, the
version number of this document. If there is no declaration and if
this document supports the "XML" feature, the value is "1.0".
|
Extends DOMNode
Each DOMDocument has a
doctype attribute whose value is either NULL or a
DOMDocumentType object.
Table 4. | Name | Type | Read-only | Description |
|---|
| publicId | string | yes | The public identifier of the external subset. | | systemId | string | yes | The system identifier of the external subset. This may be an
absolute URI or not. | | name | string | yes | The name of DTD; i.e., the name immediately following the
DOCTYPE keyword. | | entities | DOMNamedNodeMap | yes |
A DOMNamedNodeMap containing the general
entities, both external and internal, declared in the DTD.
| | notations | DOMNamedNodeMap | yes |
A DOMNamedNodeMap containing the notations
declared in the DTD.
| | internalSubset | string | yes |
The internal subset as a string, or null if there is none. This is
does not contain the delimiting square brackets.
|
Extends DOMNode.
Table 5. | Name | Type | Read-only | Description |
|---|
| schemaTypeInfo | bool | yes | Not implemented yet, always return TRUE | | tagName | string | yes | The element name |
Extends DOMNode
This interface represents a known entity, either parsed or unparsed, in
an XML document.
Table 6. | Name | Type | Read-only | Description |
|---|
| publicId | string | yes |
The public identifier associated with the entity if specified, and
NULL otherwise.
| | systemId | string | yes |
The system identifier associated with the entity if specified, and
NULL otherwise. This may be an absolute URI or not.
| | notationName | string | yes |
For unparsed entities, the name of the notation for the entity. For
parsed entities, this is NULL.
| | actualEncoding | string | no |
An attribute specifying the encoding used for this entity at the
time of parsing, when it is an external parsed entity. This is
NULL if it an entity from the internal subset or if it is not
known.
| | encoding | string | yes |
An attribute specifying, as part of the text declaration, the
encoding of this entity, when it is an external parsed entity. This
is NULL otherwise.
| | version | string | yes |
An attribute specifying, as part of the text declaration, the
version number of this entity, when it is an external parsed
entity. This is NULL otherwise.
|
DOM operations raise exceptions under particular circumstances, i.e.,
when an operation is impossible to perform for logical reasons.
See also Chapter 20.
Table 7. | Name | Type | Read-only | Description |
|---|
| code | int | yes | An integer indicating the type of error generated |
The DOMImplementation interface provides a number
of methods for performing operations that are independent of any
particular instance of the document object model.
Table 8. | Name | Type | Read-only | Description |
|---|
| nodeName | string | yes | Returns the more accurate name for the current node type | | nodeValue | string | no | The value of this node, depending on its type. | | nodeType | int | yes | Gets the type of the node. One of the predefined XML_xxx_NODE constants | | parentNode | DOMNode | yes | The parent of this node. | | childNodes | DOMNodeList | yes |
A DOMNodeList that contains all children of
this node. If there are no children, this is an empty
DOMNodeList.
| | firstChild | DOMNode | yes |
The first child of this node. If there is no such node, this
returns NULL.
| | lastChild | DOMNode | yes |
The last child of this node. If there is no such node, this returns
NULL.
| | previousSibling | DOMNode | yes |
The node immediately preceding this node. If there is no such node,
this returns NULL.
| | nextSibling | DOMNode | yes |
The node immediately following this node. If there is no such node,
this returns NULL.
| | attributes | DOMNamedNodeMap | yes |
A DOMNamedNodeMap containing the attributes
of this node (if it is a DOMElement) or
NULL otherwise.
| | ownerDocument | DOMDocument | yes |
The DOMDocument object associated with this
node.
| | namespaceURI | string | yes |
The namespace URI of this node, or NULL if it is unspecified.
| | prefix | string | no |
The namespace prefix of this node, or NULL if it is unspecified.
| | localName | string | yes |
Returns the local part of the qualified name of this node.
| | baseURI | string | yes |
The absolute base URI of this node or NULL if the implementation
wasn't able to obtain an absolute URI.
| | textContent | string | no |
This attribute returns the text content of this node and its
descendants.
|
Table 9. | Name | Type | Read-only | Description |
|---|
| length | int | yes |
The number of nodes in the list. The range of valid child node
indices is 0 to length - 1 inclusive.
|
Extends DOMNode
Table 10. | Name | Type | Read-only | Description |
|---|
| publicId | string | yes | | | systemId | string | yes | |
Extends DOMNode.
Table 11. | Name | Type | Read-only | Description |
|---|
| target | string | yes | | | data | string | no | |
Extends DOMCharacterData.
Table 12. | Name | Type | Read-only | Description |
|---|
| wholeText | string | yes | |
Table 13. | Name | Type | Read-only | Description |
|---|
| document | DOMDocument | | |
Many examples in this reference require an XML file. We will use
book.xml that contains the following:
Example 1. chapter.xml <?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<book id="listing">
<title>My lists</title>
<chapter id="books">
<title>My books</title>
<para>
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Title</entry>
<entry>Author</entry>
<entry>Language</entry>
<entry>ISBN</entry>
</row>
</thead>
<tbody>
<row>
<entry>The Grapes of Wrath</entry>
<entry>John Steinbeck</entry>
<entry>en</entry>
<entry>0140186409</entry>
</row>
<row>
<entry>The Pearl</entry>
<entry>John Steinbeck</entry>
<entry>en</entry>
<entry>014017737X</entry>
</row>
<row>
<entry>Samarcande</entry>
<entry>Amine Maalouf</entry>
<entry>fr</entry>
<entry>2253051209</entry>
</row>
<!-- TODO: I have a lot of remaining books to add.. -->
</tbody>
</tgroup>
</informaltable>
</para>
</chapter>
</book> |
|
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
Table 14. XML constants | Constant | Value | Description |
|---|
|
XML_ELEMENT_NODE
(integer)
| 1 | Node is a DOMElement | |
XML_ATTRIBUTE_NODE
(integer)
| 2 | Node is a DOMAttr | |
XML_TEXT_NODE
(integer)
| 3 | Node is a DOMText | |
XML_CDATA_SECTION_NODE
(integer)
| 4 | Node is a DOMCharacterData | |
XML_ENTITY_REF_NODE
(integer)
| 5 | Node is a DOMEntityReference | |
XML_ENTITY_NODE
(integer)
| 6 | Node is a DOMEntity | |
XML_PI_NODE
(integer)
| 7 | Node is a DOMProcessingInstruction | |
XML_COMMENT_NODE
(integer)
| 8 | Node is a DOMComment | |
XML_DOCUMENT_NODE
(integer)
| 9 | Node is a DOMDocument | |
XML_DOCUMENT_TYPE_NODE
(integer)
| 10 | Node is a DOMDocumentType | |
XML_DOCUMENT_FRAG_NODE
(integer)
| 11 | Node is a DOMDocumentFragment | |
XML_NOTATION_NODE
(integer)
| 12 | Node is a DOMNotation | |
XML_HTML_DOCUMENT_NODE
(integer)
| 13 | | |
XML_DTD_NODE
(integer)
| 14 | | |
XML_ELEMENT_DECL_NODE
(integer)
| 15 | | |
XML_ATTRIBUTE_DECL_NODE
(integer)
| 16 | | |
XML_ENTITY_DECL_NODE
(integer)
| 17 | | |
XML_NAMESPACE_DECL_NODE
(integer)
| 18 | | |
XML_ATTRIBUTE_CDATA
(integer)
| 1 | | |
XML_ATTRIBUTE_ID
(integer)
| 2 | | |
XML_ATTRIBUTE_IDREF
(integer)
| 3 | | |
XML_ATTRIBUTE_IDREFS
(integer)
| 4 | | |
XML_ATTRIBUTE_ENTITY
(integer)
| 5 | | |
XML_ATTRIBUTE_NMTOKEN
(integer)
| 7 | | |
XML_ATTRIBUTE_NMTOKENS
(integer)
| 8 | | |
XML_ATTRIBUTE_ENUMERATION
(integer)
| 9 | | |
XML_ATTRIBUTE_NOTATION
(integer)
| 10 | |
Table 15. DOMException constants | Constant | Value | Description |
|---|
|
DOM_INDEX_SIZE_ERR
(integer)
| 1 |
If index or size is negative, or greater than the allowed value.
| |
DOMSTRING_SIZE_ERR
(integer)
| 2 |
If the specified range of text does not fit into a
DOMString.
| |
DOM_HIERARCHY_REQUEST_ERR
(integer)
| 3 | If any node is inserted somewhere it doesn't belong | |
DOM_WRONG_DOCUMENT_ERR
(integer)
| 4 |
If a node is used in a different document than the one that created it.
| |
DOM_INVALID_CHARACTER_ERR
(integer)
| 5 |
If an invalid or illegal character is specified, such as in a name.
| |
DOM_NO_DATA_ALLOWED_ERR
(integer)
| 6 |
If data is specified for a node which does not support data.
| |
DOM_NO_MODIFICATION_ALLOWED_ERR
(integer)
| 7 |
If an attempt is made to modify an object where modifications are not allowed.
| |
DOM_NOT_FOUND_ERR
(integer)
| 8 |
If an attempt is made to reference a node in a context where it does not exist.
| |
DOM_NOT_SUPPORTED_ERR
(integer)
| 9 |
If the implementation does not support the requested type of object or operation.
| |
DOM_INUSE_ATTRIBUTE_ERR
(integer)
| 10 |
If an attempt is made to add an attribute that is already in use elsewhere.
| |
DOM_INVALID_STATE_ERR
(integer)
| 11 |
If an attempt is made to use an object that is not, or is no longer, usable.
| |
DOM_SYNTAX_ERR
(integer)
| 12 | If an invalid or illegal string is specified. | |
DOM_INVALID_MODIFICATION_ERR
(integer)
| 13 | If an attempt is made to modify the type of the underlying object. | |
DOM_NAMESPACE_ERR
(integer)
| 14 |
If an attempt is made to create or change an object in a way which is
incorrect with regard to namespaces.
| |
DOM_INVALID_ACCESS_ERR
(integer)
| 15 |
If a parameter or an operation is not supported by the underlying object.
| |
DOM_VALIDATION_ERR
(integer)
| 16 |
If a call to a method such as insertBefore or removeChild would make the Node
invalid with respect to "partial validity", this exception would be raised and
the operation would not be done.
|
User Contributed Notes
DOM Functions
toma at smartsemantics dot com
11-May-2005 10:22
Based loosely on some previously provided examples, here are 2 functions to read in an XML file using DOM and parse it into a usable array for reading/access. The output is a very clean array.
------------------------------------
function LoadXMLFile( $path,$file) {
$oldpath= getcwd( ) ;
chdir( $path) ;
$dom= DOMDocument::load( $path.$file) ;
chdir( $oldpath) ;
$xml= array( ) ;
parseXML( $dom,$xml) ;
return $xml;
}
function parseXML( $dom,&$arr)
{
$arr_ptr= &$arr;
$dom= $dom->firstChild;
while( !is_null( $dom) ) {
switch ( $dom->nodeType) {
case XML_TEXT_NODE:
if( trim( $dom->nodeValue) != '') {
if( is_array( $arr_ptr) ) {
$arr_ptr[]= $dom->nodeValue;
}
elseif( $arr_ptr != '') {
$arr_ptr= array( $arr_ptr) ;
$arr_ptr[]= $dom->nodeValue;
}
else{
$arr_ptr= $dom->nodeValue;
}
}
break;
case XML_ELEMENT_NODE:
$arr_ptr= &$arr[$dom->nodeName];
if ( $dom->hasAttributes( ) ) {
$attributes= $dom->attributes;
foreach( $attributes as $index= >$domobj) {
$arr_ptr['ATTRIBUTES'] [$domobj->name]= $domobj->value;
}
}
break;
}
if( $dom->hasChildNodes( ) ) {
parseXML( $dom,$arr_ptr) ;
}
$dom= $dom->nextSibling;
}
}
------------------------------------
Example usage:
$CONFIG= LoadXMLFile( '/var/www/html/site.com/php-bin/','config.xml') ;
sofa77 at gmx dot de
02-May-2005 11:34
please take account, that the following - usually working check - won't work as expected. i was looking for a too long time for an error, where no error were.
<?php
$last = null;
$dom = new DOMDocument;
$first = $dom->createElement('firstEl');
$last = $dom->appendChild($first);
$second = $dom->createElement('secondEl');
$last = $last->appendChild($second);
echo htmlspecialchars($dom->saveXML());
echo $last->parentNode->nodeName;
if(!isset($last->parentNode->nodeName))
{
trigger_error('WRONG NOTICE: no parent', E_USER_NOTICE);
}
if(!$last->parentNode)
{
trigger_error('no parent', E_USER_NOTICE);
}
if(!$last->parentNode->nodeName)
{
trigger_error('no parent', E_USER_NOTICE);
}
?>
spammable69 at hotmail dot com
12-Apr-2005 01:18
I wrote a framework to implement the StyleSheet interfaces as specified on the W3C website. The code is written in PHP, and is NOT a complete implementation. Use it how ya like. I was planning on adding the CSSStyleSheet interfaces as well. Feel free to ask.
<?
class StyleSheetList {
public length;
private self;
function __construct ( ) {
$this->self = array();
}
function __get($property, $&ret) {
if($property == 'length')
$ret = count($this->self);
return true;
}
function __set($property, $val) {
if($property == 'length')
return true;
}
function item( $index ) {
return $this->self[$index];
}
}
class MediaList extends StyleSheetList {
function appendMedium ( $newMedium ) {
array_push($this->self, $newMedium);
}
function deleteMedium ( $oldMedium ) {
foreach($this->self as $item) {
if( $item == $oldMedium ) {
$item = $this->self[ $this->length-1 ];
array_pop($this->self);
break;
}
}
}
}
class DocumentStyle {
public styleSheets;
function __construct ( ) {
$this->styleSheets = new StyleSheetList();
}
function __set($property, $val) {
if($property == 'styleSheets')
return true;
}
}
class LinkStyle {
public sheet;
function __construct () {
$this->sheet = new StyleSheet();
}
function __set($property, $val) {
if($property == 'sheet')
return true;
}
}
class StyleSheet {
public type;
public disabled;
public ownerNode;
public parentStyleSheet;
public href;
public title;
public media;
function __construct( $type, $disabled, $ownerNode, $parentStyleSheet, $href, $title){
$this->type = $type;
$this->disabled = $disabled;
$this->media = new MediaList();
$this->ownerNode = $ownerNode;
$this->parentStyleSheet = $parentStyleSheet;
$this->href = $href;
$this->title = $title;
}
}
?>
Only contactable via http://murpsoft.com/contact.html
shruti224 at yahoo dot com
31-Mar-2005 10:25
my bad..its not an attribute ..its a text element node so if one checks for that, it can be easily corrected.
Wrote the corrected function. I hope it takes care of all conditions. If someone finds any issues with it, I would be glad to know about it.
function readXml($domnode, &$array)
{
$array_ptr = &$array;
$domnode = $domnode->firstChild;
while (!is_null($domnode))
{
switch ($domnode->nodeType)
{
case XML_TEXT_NODE: if(!(trim($domnode->nodeValue) == ""))
$array_ptr['cdata'] = $domnode->nodeValue;
break;
case XML_ELEMENT_NODE:
$array_ptr = &$array[$domnode->nodeName][];
if ($domnode->hasAttributes() )
{
$attributes = $domnode->attributes;
foreach ($attributes as $index => $domobj)
{
$array_ptr[$domobj->name] = $domobj->value;
}
}
break;
}
if ( $domnode->hasChildNodes() )
{
readXml($domnode, $array_ptr);
}
$domnode = $domnode->nextSibling;
}
}
roger4a45 at yahoo dot es
23-Feb-2005 06:35
Output a special chars like à in your XML/XSLT
Following example create a easy XML that is transformed by a xsl i'll show below:
XSL FILE v1.xsl
<?xml version="1.0" encoding="ISO-8859-1"?>
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns="http://www.w3.org/TR/REC-html40">
<xsl:template match="TEST">
<xsl:value-of select="NAME"/><BR/>
</xsl:template>
</xsl:stylesheet>
PHP SOURCE CODE
<?php
$xml = new DOMDocument('1.0', 'utf-8'); $xsl = new DOMDocument;
$xsl->load('v1.xsl');
$proc = new XSLTProcessor;
$root = $xml->CreateElement("TEST");
$val = utf8_encode ('Andrés Poluk'); $child = $xml->CreateElement("NAME",$val);
$root->appendChild($child);
$xml->appendChild($root);
$proc->importStyleSheet($xsl);
echo $proc->transformToXML($xml);
?>
rabarca[at]dcc[dot]uchile[dot]cl
13-Jan-2005 09:11
to create a simple array from a plist (http://developer.apple.com/documentation/MacOSX/
Conceptual/BPRuntimeConfig/Concepts/ConfigFiles.html), you can use this modification from timo[dot]goetze[at]electricpaper[dot]de's function:
<?php
function plist_to_array ($domnode, &$array, $name) {
$array_ptr = &$array;
$domnode = $domnode->firstChild;
while (!is_null($domnode)) {
if (! (trim($domnode->nodeValue) == "") ) {
switch ($domnode->nodeName)
{
case "dict": {
if ($name != "")
$array_ptr = &$array[$name][];
break;
}
case "key": {
if ($domnode->nodeValue != $name)
$name = $domnode->nodeValue;
break;
}
case "string": {
$array_ptr[$name] = $domnode->nodeValue;
break;
}
}
if ( $domnode->hasChildNodes() ) {
plist_to_array ($domnode, $array_ptr, $name);
}
}
$domnode = $domnode->nextSibling;
}
}
?>
so far it only works with string types, but you can extend it to the other common data types.
timo[dot]goetze[at]electricpaper[dot]de
12-Dec-2004 07:17
Here's a function to transform a DOMNode in an array.
greetings,
TIMO
<?
function dom_to_simple_array($domnode, &$array) {
$array_ptr = &$array;
$domnode = $domnode->firstChild;
while (!is_null($domnode)) {
if (! (trim($domnode->nodeValue) == "") ) {
switch ($domnode->nodeType) {
case XML_TEXT_NODE: {
$array_ptr['cdata'] = $domnode->nodeValue;
break;
}
case XML_ELEMENT_NODE: {
$array_ptr = &$array[$domnode->nodeName][];
if ($domnode->hasAttributes() ) {
foreach ($domnode->attributes as $d_attribute){
$array_ptr[$d_attribute->name] = $d_attribute->value;
}
}
break;
}
}
if ( $domnode->hasChildNodes() ) {
dom_to_simple_array($domnode, $array_ptr);
}
}
$domnode = $domnode->nextSibling;
}
}
?>
M. Gutbrod
27-Nov-2004 06:12
If you have two nodes in a HTML DOM and you want to get all text nodes between them, you can do someting like this:
<?php
$n=$dom->lastChild->previousSibling->firstChild->nextSibling;
$e=$dom->lastChild;
while (true) {
if ($n->nodeType===XML_TEXT_NODE) { echo $n->nodeValue;}
if ($n->isSameNode($e)) {
break;}
if (($n->firstChild !== NULL) && !$up) {
$n=$n->firstChild;}
elseif ($n->nextSibling !== NULL) {
$up=false;
$n=$n->nextSibling;}
elseif ($n->parentNode !== NULL) {
$up=true;
$n=$n->parentNode;}
else {
break;}}
?>
oliver dot christen at camptocamp dot com
19-Nov-2004 11:20
simple exemple of how to get the value of an attribute, delete that attribute and create a new element at the place we want with the value of the attribute
<?xml version="1.0"?>
<book type="paperback">
<title name='MAP'>Red Nails</title>
<price>$12.99</price>
<author>
<name first="Robert" middle="E" last="Howard"/>
<birthdate>9/21/1977</birthdate>
</author>
</book>
<?php
$file = 'book.xml';
$doc = new domDocument;
if (file_exists($file)) {
$doc->load($file);
} else {
exit('Erreur !.');
}
$xpath = new domXPath($doc);
$query = "//author/*";
$xpathQuery = $xpath->query($query);
$size = $xpathQuery->length;
for ($i=0; $i<$size; $i++){
$node = $xpathQuery->item($i);
if ($node->nodeName == 'name' && $node->hasAttributes()){
foreach ($node->attributes as $attribute) {
if ($attribute->name == 'last' && $attribute->value == 'Howard'){
foreach ($node->attributes as $attribute) {
if ($attribute->name == 'first'){
$firstname = $attribute->value;
$refnode = $node;
$node->removeAttribute('first');
}
}
}
}
}
}
if (isset($refnode)) {
$parentnode = $refnode->parentNode;
$newnode = $doc->createElement('firstname', $firstname);
$newtextnode = $doc->createTextNode(chr(10));
$newnode = $parentnode->insertBefore($newnode, $refnode);
$newtextnode = $parentnode->insertBefore($newtextnode, $refnode);
}
print $doc->saveXML();
?>
| |
scandir