Document Object Model

Table of Contents

Introduction
Installing/Configuring
- Requirements
- Installation
- Runtime Configuration
- Resource Types
Predefined Constants
Examples
DOMAttr — The DOMAttr class
- DOMAttr::__construct — Creates a new DOMAttr object
- DOMAttr::isId — Checks if attribute is a defined ID
DOMCdataSection — The DOMCdataSection class
- DOMCdataSection::__construct — Constructs a new DOMCdataSection object
DOMCharacterData — The DOMCharacterData class
- DOMCharacterData::appendData — Append the string to the end of the character data of the node
- DOMCharacterData::deleteData — Remove a range of characters from the node
- DOMCharacterData::insertData — Insert a string at the specified 16-bit unit offset
- DOMCharacterData::replaceData — Replace a substring within the DOMCharacterData node
- DOMCharacterData::substringData — Extracts a range of data from the node
DOMComment — The DOMComment class
- DOMComment::__construct — Creates a new DOMComment object
DOMDocument — The DOMDocument class
- DOMDocument::__construct — Creates a new DOMDocument object
- DOMDocument::createAttribute — Create new attribute
- DOMDocument::createAttributeNS — Create new attribute node with an associated namespace
- DOMDocument::createCDATASection — Create new cdata node
- DOMDocument::createComment — Create new comment node
- DOMDocument::createDocumentFragment — Create new document fragment
- DOMDocument::createElement — Create new element node
- DOMDocument::createElementNS — Create new element node with an associated namespace
- DOMDocument::createEntityReference — Create new entity reference node
- DOMDocument::createProcessingInstruction — Creates new PI node
- DOMDocument::createTextNode — Create new text node
- DOMDocument::getElementById — Searches for an element with a certain id
- DOMDocument::getElementsByTagName — Searches for all elements with given local tag name
- DOMDocument::getElementsByTagNameNS — Searches for all elements with given tag name in specified namespace
- DOMDocument::importNode — Import node into current document
- DOMDocument::load — Load XML from a file
- DOMDocument::loadHTML — Load HTML from a string
- DOMDocument::loadHTMLFile — Load HTML from a file
- DOMDocument::loadXML — Load XML from a string
- DOMDocument::normalizeDocument — Normalizes the document
- DOMDocument::registerNodeClass — Register extended class used to create base node type
- DOMDocument::relaxNGValidate — Performs relaxNG validation on the document
- DOMDocument::relaxNGValidateSource — Performs relaxNG validation on the document
- DOMDocument::save — Dumps the internal XML tree back into a file
- DOMDocument::saveHTML — Dumps the internal document into a string using HTML formatting
- DOMDocument::saveHTMLFile — Dumps the internal document into a file using HTML formatting
- DOMDocument::saveXML — Dumps the internal XML tree back into a string
- DOMDocument::schemaValidate — Validates a document based on a schema
- DOMDocument::schemaValidateSource — Validates a document based on a schema
- DOMDocument::validate — Validates the document based on its DTD
- DOMDocument::xinclude — Substitutes XIncludes in a DOMDocument Object
DOMDocumentFragment — The DOMDocumentFragment class
- DOMDocumentFragment::appendXML — Append raw XML data
DOMDocumentType — The DOMDocumentType class
DOMElement — The DOMElement class
- DOMElement::__construct — Creates a new DOMElement object
- DOMElement::getAttribute — Returns value of attribute
- DOMElement::getAttributeNode — Returns attribute node
- DOMElement::getAttributeNodeNS — Returns attribute node
- DOMElement::getAttributeNS — Returns value of attribute
- DOMElement::getElementsByTagName — Gets elements by tagname
- DOMElement::getElementsByTagNameNS — Get elements by namespaceURI and localName
- DOMElement::hasAttribute — Checks to see if attribute exists
- DOMElement::hasAttributeNS — Checks to see if attribute exists
- DOMElement::removeAttribute — Removes attribute
- DOMElement::removeAttributeNode — Removes attribute
- DOMElement::removeAttributeNS — Removes attribute
- DOMElement::setAttribute — Adds new attribute
- DOMElement::setAttributeNode — Adds new attribute node to element
- DOMElement::setAttributeNodeNS — Adds new attribute node to element
- DOMElement::setAttributeNS — Adds new attribute
- DOMElement::setIdAttribute — Declares the attribute specified by name to be of type ID
- DOMElement::setIdAttributeNode — Declares the attribute specified by node to be of type ID
- DOMElement::setIdAttributeNS — Declares the attribute specified by local name and namespace URI to be of type ID
DOMEntity — The DOMEntity class
DOMEntityReference — The DOMEntityReference class
- DOMEntityReference::__construct — Creates a new DOMEntityReference object
DOMException — The DOMException class
DOMImplementation — The DOMImplementation class
- DOMImplementation::__construct — Creates a new DOMImplementation object
- DOMImplementation::createDocument — Creates a DOMDocument object of the specified type with its document element
- DOMImplementation::createDocumentType — Creates an empty DOMDocumentType object
- DOMImplementation::hasFeature — Test if the DOM implementation implements a specific feature
DOMNamedNodeMap — The DOMNamedNodeMap class
- DOMNamedNodeMap::getNamedItem — Retrieves a node specified by name
- DOMNamedNodeMap::getNamedItemNS — Retrieves a node specified by local name and namespace URI
- DOMNamedNodeMap::item — Retrieves a node specified by index
DOMNode — The DOMNode class
- DOMNode::appendChild — Adds new child at the end of the children
- DOMNode::C14N — Canonicalize nodes to a string
- DOMNode::C14NFile — Canonicalize nodes to a file
- DOMNode::cloneNode — Clones a node
- DOMNode::getLineNo — Get line number for a node
- DOMNode::getNodePath — Get an XPath for a node
- DOMNode::hasAttributes — Checks if node has attributes
- DOMNode::hasChildNodes — Checks if node has children
- DOMNode::insertBefore — Adds a new child before a reference node
- DOMNode::isDefaultNamespace — Checks if the specified namespaceURI is the default namespace or not
- DOMNode::isSameNode — Indicates if two nodes are the same node
- DOMNode::isSupported — Checks if feature is supported for specified version
- DOMNode::lookupNamespaceURI — Gets the namespace URI of the node based on the prefix
- DOMNode::lookupPrefix — Gets the namespace prefix of the node based on the namespace URI
- DOMNode::normalize — Normalizes the node
- DOMNode::removeChild — Removes child from list of children
- DOMNode::replaceChild — Replaces a child
DOMNodeList — The DOMNodeList class
- DOMNodelist::item — Retrieves a node specified by index
DOMNotation — The DOMNotation class
DOMProcessingInstruction — The DOMProcessingInstruction class
- DOMProcessingInstruction::__construct — Creates a new DOMProcessingInstruction object
DOMText — The DOMText class
- DOMText::__construct — Creates a new DOMText object
- DOMText::isWhitespaceInElementContent — Indicates whether this text node contains whitespace
- DOMText::splitText — Breaks this node into two nodes at the specified offset
DOMXPath — The DOMXPath class
- DOMXPath::__construct — Creates a new DOMXPath object
- DOMXPath::evaluate — Evaluates the given XPath expression and returns a typed result if possible
- DOMXPath::query — Evaluates the given XPath expression
- DOMXPath::registerNamespace — Registers the namespace with the DOMXPath object
- DOMXPath::registerPhpFunctions — Register PHP functions as XPath functions
DOM Functions
- dom_import_simplexml — Gets a DOMElement object from a SimpleXMLElement object

The DOMAttr class

Introduction

DOMAttr represents an attribute in the DOMElement object.

Class synopsis

DOMAttr

class DOMAttr extends DOMNode {

/* Properties */

public readonly string $name ;

public readonly DOMElement $ownerElement ;

public readonly bool $schemaTypeInfo ;

public readonly bool $specified ;

public string $value ;

/* Methods */

public __construct ( string $name [, string $value ] )

public bool isId ( void )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

name: The name of the attribute
ownerElement: The element which contains the attribute
schemaTypeInfo: Not implemented yet, always is NULL
specified: Not implemented yet, always is NULL
value: The value of the attribute

The DOMCdataSection class

Introduction

The DOMCdataSection inherits from DOMText for textural representation of CData constructs.

Class synopsis

DOMCdataSection

class DOMCdataSection extends DOMText {

/* Methods */

public __construct ( string $value )

/* Inherited methods */

public bool DOMText::isWhitespaceInElementContent ( void )

public DOMText DOMText::splitText ( int $offset )

}

The DOMCharacterData class

Introduction

Represents nodes with character data. No nodes directly correspond to this class, but other nodes do inherit from it.

Class synopsis

DOMCharacterData

class DOMCharacterData extends DOMNode {

/* Properties */

public string $data ;

readonly public int $length ;

/* Methods */

void appendData ( string $data )

void deleteData ( int $offset , int $count )

void insertData ( int $offset , string $data )

void replaceData ( int $offset , int $count , string $data )

string substringData ( int $offset , int $count )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

data: The contents of the node.
length: The length of the contents.

The DOMComment class

Introduction

Represents comment nodes, characters delimited by .

Class synopsis

DOMComment

class DOMComment extends DOMCharacterData {

/* Methods */

public __construct ([ string $value ] )

/* Inherited methods */

void DOMCharacterData::appendData ( string $data )

void DOMCharacterData::deleteData ( int $offset , int $count )

void DOMCharacterData::insertData ( int $offset , string $data )

void DOMCharacterData::replaceData ( int $offset , int $count , string $data )

string DOMCharacterData::substringData ( int $offset , int $count )

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

The DOMDocument class

Introduction

Represents an entire HTML or XML document; serves as the root of the document tree.

Class synopsis

DOMDocument

class DOMDocument extends DOMNode {

/* Properties */

readonly public string $actualEncoding ;

readonly public DOMConfiguration $config ;

readonly public DOMDocumentType $doctype ;

readonly public DOMElement $documentElement ;

public string $documentURI ;

public string $encoding ;

public bool $formatOutput ;

readonly public DOMImplementation $implementation ;

public bool $preserveWhiteSpace = true ;

public bool $recover ;

public bool $resolveExternals ;

public bool $standalone ;

public bool $strictErrorChecking = true ;

public bool $substituteEntities ;

public bool $validateOnParse = false ;

public string $version ;

readonly public string $xmlEncoding ;

public bool $xmlStandalone ;

public string $xmlVersion ;

/* Methods */

public __construct ([ string $version [, string $encoding ]] )

public DOMAttr createAttribute ( string $name )

public DOMAttr createAttributeNS ( string $namespaceURI , string $qualifiedName )

public DOMCDATASection createCDATASection ( string $data )

public DOMComment createComment ( string $data )

public DOMDocumentFragment createDocumentFragment ( void )

public DOMElement createElement ( string $name [, string $value ] )

public DOMElement createElementNS ( string $namespaceURI , string $qualifiedName [, string $value ] )

public DOMEntityReference createEntityReference ( string $name )

public DOMProcessingInstruction createProcessingInstruction ( string $target [, string $data ] )

public DOMText createTextNode ( string $content )

public DOMElement getElementById ( string $elementId )

public DOMNodeList getElementsByTagName ( string $name )

public DOMNodeList getElementsByTagNameNS ( string $namespaceURI , string $localName )

public DOMNode importNode ( DOMNode $importedNode [, bool $deep ] )

public mixed load ( string $filename [, int $options = 0 ] )

public bool loadHTML ( string $source [, int $options = 0 ] )

public bool loadHTMLFile ( string $filename [, int $options = 0 ] )

public mixed loadXML ( string $source [, int $options = 0 ] )

public void normalizeDocument ( void )

public bool registerNodeClass ( string $baseclass , string $extendedclass )

public bool relaxNGValidate ( string $filename )

public bool relaxNGValidateSource ( string $source )

public int save ( string $filename [, int $options ] )

public string saveHTML ([ DOMNode $node = NULL ] )

public int saveHTMLFile ( string $filename )

public string saveXML ([ DOMNode $node [, int $options ]] )

public bool schemaValidate ( string $filename [, int $flags ] )

public bool schemaValidateSource ( string $source [, int $flags ] )

public bool validate ( void )

public int xinclude ([ int $options ] )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

actualEncoding: Deprecated. Actual encoding of the document, is a readonly equivalent to encoding.
config: Deprecated. Configuration used when DOMDocument::normalizeDocument is invoked.
doctype: The Document Type Declaration associated with this document.
documentElement: This is a convenience attribute that allows direct access to the child node that is the document element of the document.
documentURI: The location of the document or NULL if undefined.
encoding: Encoding of the document, as specified by the XML declaration. This attribute is not present in the final DOM Level 3 specification, but is the only way of manipulating XML document encoding in this implementation.
formatOutput: Nicely formats output with indentation and extra space.
implementation: The DOMImplementation object that handles this document.
preserveWhiteSpace: Do not remove redundant white space. Default to TRUE.
recover: Proprietary. Enables recovery mode, i.e. trying to parse non-well formed documents. This attribute is not part of the DOM specification and is specific to libxml.
resolveExternals: Set it to TRUE to load external entities from a doctype declaration. This is useful for including character entities in your XML document.
standalone: Deprecated. Whether or not the document is standalone, as specified by the XML declaration, corresponds to xmlStandalone.
strictErrorChecking: Throws DOMException on errors. Default to TRUE.
substituteEntities: Proprietary. Whether or not to substitute entities. This attribute is not part of the DOM specification and is specific to libxml.
validateOnParse: Loads and validates against the DTD. Default to FALSE.
version: Deprecated. Version of XML, corresponds to xmlVersion.
xmlEncoding: 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: An attribute specifying, as part of the XML declaration, whether this document is standalone. This is FALSE when unspecified.
xmlVersion: 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".

Notes

Note:
The DOM extension uses UTF-8 encoding. Use utf8_encode and utf8_decode to work with texts in ISO-8859-1 encoding or Iconv for other encodings.

The DOMDocumentFragment class

Class synopsis

DOMDocumentFragment

class DOMDocumentFragment extends DOMNode {

/* Properties */

/* Methods */

public bool appendXML ( string $data )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

The DOMDocumentType class

Introduction

Each DOMDocument has a doctype attribute whose value is either NULL or a DOMDocumentType object.

Class synopsis

DOMDocumentType

class DOMDocumentType extends DOMNode {

/* Properties */

readonly public string $publicId ;

readonly public string $systemId ;

readonly public string $name ;

readonly public DOMNamedNodeMap $entities ;

readonly public DOMNamedNodeMap $notations ;

readonly public string $internalSubset ;

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

publicId: The public identifier of the external subset.
systemId: The system identifier of the external subset. This may be an absolute URI or not.
name: The name of DTD; i.e., the name immediately following the DOCTYPE keyword.
entities: A DOMNamedNodeMap containing the general entities, both external and internal, declared in the DTD.
notations: A DOMNamedNodeMap containing the notations declared in the DTD.
internalSubset: The internal subset as a string, or null if there is none. This does not contain the delimiting square brackets.

The DOMElement class

Class synopsis

DOMElement

class DOMElement extends DOMNode {

/* Properties */

readonly public bool $schemaTypeInfo ;

readonly public string $tagName ;

/* Methods */

public __construct ( string $name [, string $value [, string $namespaceURI ]] )

public string getAttribute ( string $name )

public DOMAttr getAttributeNode ( string $name )

public DOMAttr getAttributeNodeNS ( string $namespaceURI , string $localName )

public string getAttributeNS ( string $namespaceURI , string $localName )

public DOMNodeList getElementsByTagName ( string $name )

public DOMNodeList getElementsByTagNameNS ( string $namespaceURI , string $localName )

public bool hasAttribute ( string $name )

public bool hasAttributeNS ( string $namespaceURI , string $localName )

public bool removeAttribute ( string $name )

public bool removeAttributeNode ( DOMAttr $oldnode )

public bool removeAttributeNS ( string $namespaceURI , string $localName )

public DOMAttr setAttribute ( string $name , string $value )

public DOMAttr setAttributeNode ( DOMAttr $attr )

public DOMAttr setAttributeNodeNS ( DOMAttr $attr )

public void setAttributeNS ( string $namespaceURI , string $qualifiedName , string $value )

public void setIdAttribute ( string $name , bool $isId )

public void setIdAttributeNode ( DOMAttr $attr , bool $isId )

public void setIdAttributeNS ( string $namespaceURI , string $localName , bool $isId )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

schemaTypeInfo: Not implemented yet, always return NULL
tagName: The element name

Notes

Note:
The DOM extension uses UTF-8 encoding. Use utf8_encode and utf8_decode to work with texts in ISO-8859-1 encoding or Iconv for other encodings.

The DOMEntity class

Introduction

This interface represents a known entity, either parsed or unparsed, in an XML document.

Class synopsis

DOMEntity

class DOMEntity extends DOMNode {

/* Properties */

readonly public string $publicId ;

readonly public string $systemId ;

readonly public string $notationName ;

public string $actualEncoding ;

readonly public string $encoding ;

readonly public string $version ;

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

publicId: The public identifier associated with the entity if specified, and NULL otherwise.
systemId: The system identifier associated with the entity if specified, and NULL otherwise. This may be an absolute URI or not.
notationName: For unparsed entities, the name of the notation for the entity. For parsed entities, this is NULL.
actualEncoding: 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: 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: 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.

The DOMEntityReference class

Class synopsis

DOMEntityReference

class DOMEntityReference extends DOMNode {

/* Properties */

/* Methods */

public __construct ( string $name )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

The DOMException class

Introduction

DOM operations raise exceptions under particular circumstances, i.e., when an operation is impossible to perform for logical reasons.

Class synopsis

DOMException

class DOMException extends Exception {

/* Properties */

readonly public int $code ;

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Throwable Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

Properties

code: An integer indicating the type of error generated

The DOMImplementation class

Introduction

The DOMImplementation interface provides a number of methods for performing operations that are independent of any particular instance of the document object model.

Class synopsis

DOMImplementation

class DOMImplementation {

/* Properties */

/* Methods */

__construct ( void )

public DOMDocument createDocument ([ string $namespaceURI = NULL [, string $qualifiedName = NULL [, DOMDocumentType $doctype = NULL ]]] )

public DOMDocumentType createDocumentType ([ string $qualifiedName = NULL [, string $publicId = NULL [, string $systemId = NULL ]]] )

public bool hasFeature ( string $feature , string $version )

}

The DOMNamedNodeMap class

Class synopsis

DOMNamedNodeMap

class DOMNamedNodeMap implements Traversable {

/* Properties */

readonly public int $length ;

/* Methods */

DOMNode getNamedItem ( string $name )

DOMNode getNamedItemNS ( string $namespaceURI , string $localName )

DOMNode item ( int $index )

}

Properties

length: The number of nodes in the map. The range of valid child node indices is 0 to length - 1 inclusive.

The DOMNode class

Class synopsis

DOMNode

class DOMNode {

/* Properties */

public readonly string $nodeName ;

public string $nodeValue ;

public readonly int $nodeType ;

public readonly DOMNode $parentNode ;

public readonly DOMNodeList $childNodes ;

public readonly DOMNode $firstChild ;

public readonly DOMNode $lastChild ;

public readonly DOMNode $previousSibling ;

public readonly DOMNode $nextSibling ;

public readonly DOMNamedNodeMap $attributes ;

public readonly DOMDocument $ownerDocument ;

public readonly string $namespaceURI ;

public string $prefix ;

public readonly string $localName ;

public readonly string $baseURI ;

public string $textContent ;

/* Methods */

public DOMNode appendChild ( DOMNode $newnode )

public string C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode cloneNode ([ bool $deep ] )

public int getLineNo ( void )

public string getNodePath ( void )

public bool hasAttributes ( void )

public bool hasChildNodes ( void )

public DOMNode insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool isDefaultNamespace ( string $namespaceURI )

public bool isSameNode ( DOMNode $node )

public bool isSupported ( string $feature , string $version )

public string lookupNamespaceURI ( string $prefix )

public string lookupPrefix ( string $namespaceURI )

public void normalize ( void )

public DOMNode removeChild ( DOMNode $oldnode )

public DOMNode replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

nodeName: Returns the most accurate name for the current node type
nodeValue: The value of this node, depending on its type. Contrary to the W3C specification, the node value of DOMElement nodes is equal to DOMNode::textContent instead of NULL.
nodeType: Gets the type of the node. One of the predefined XML_xxx_NODE constants
parentNode: The parent of this node. If there is no such node, this returns NULL.
childNodes: A DOMNodeList that contains all children of this node. If there are no children, this is an empty DOMNodeList.
firstChild: The first child of this node. If there is no such node, this returns NULL.
lastChild: The last child of this node. If there is no such node, this returns NULL.
previousSibling: The node immediately preceding this node. If there is no such node, this returns NULL.
nextSibling: The node immediately following this node. If there is no such node, this returns NULL.
attributes: A DOMNamedNodeMap containing the attributes of this node (if it is a DOMElement) or NULL otherwise.
ownerDocument: The DOMDocument object associated with this node.
namespaceURI: The namespace URI of this node, or NULL if it is unspecified.
prefix: The namespace prefix of this node, or NULL if it is unspecified.
localName: Returns the local part of the qualified name of this node.
baseURI: The absolute base URI of this node or NULL if the implementation wasn't able to obtain an absolute URI.
textContent: The text content of this node and its descendants.

Notes

Note:
The DOM extension uses UTF-8 encoding. Use utf8_encode and utf8_decode to work with texts in ISO-8859-1 encoding or Iconv for other encodings.

Changelog

Version	Description
5.6.1	The textContent property has been made writable (formerly it has been readonly).

The DOMNodeList class

Class synopsis

DOMNodeList

class DOMNodeList implements Traversable {

/* Properties */

readonly public int $length ;

/* Methods */

DOMElement DOMNodelist::item ( int $index )

}

Properties

length: The number of nodes in the list. The range of valid child node indices is 0 to length - 1 inclusive.

The DOMNotation class

Class synopsis

DOMNotation

class DOMNotation extends DOMNode {

/* Properties */

readonly public string $publicId ;

readonly public string $systemId ;

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

publicId
systemId

The DOMProcessingInstruction class

Class synopsis

DOMProcessingInstruction

class DOMProcessingInstruction extends DOMNode {

/* Properties */

readonly public string $target ;

public string $data ;

/* Methods */

public __construct ( string $name [, string $value ] )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

target
data

The DOMText class

Introduction

The DOMText class inherits from DOMCharacterData and represents the textual content of a DOMElement or DOMAttr.

Class synopsis

DOMText

class DOMText extends DOMCharacterData {

/* Properties */

readonly public string $wholeText ;

/* Methods */

public __construct ([ string $value ] )

public bool isWhitespaceInElementContent ( void )

public DOMText splitText ( int $offset )

/* Inherited methods */

public DOMNode DOMNode::appendChild ( DOMNode $newnode )

public string DOMNode::C14N ([ bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public int DOMNode::C14NFile ( string $uri [, bool $exclusive [, bool $with_comments [, array $xpath [, array $ns_prefixes ]]]] )

public DOMNode DOMNode::cloneNode ([ bool $deep ] )

public int DOMNode::getLineNo ( void )

public string DOMNode::getNodePath ( void )

public bool DOMNode::hasAttributes ( void )

public bool DOMNode::hasChildNodes ( void )

public DOMNode DOMNode::insertBefore ( DOMNode $newnode [, DOMNode $refnode ] )

public bool DOMNode::isDefaultNamespace ( string $namespaceURI )

public bool DOMNode::isSameNode ( DOMNode $node )

public bool DOMNode::isSupported ( string $feature , string $version )

public string DOMNode::lookupNamespaceURI ( string $prefix )

public string DOMNode::lookupPrefix ( string $namespaceURI )

public void DOMNode::normalize ( void )

public DOMNode DOMNode::removeChild ( DOMNode $oldnode )

public DOMNode DOMNode::replaceChild ( DOMNode $newnode , DOMNode $oldnode )

}

Properties

wholeText: Holds all the text of logically-adjacent (not separated by Element, Comment or Processing Instruction) Text nodes.

The DOMXPath class

Introduction

Supports XPath 1.0

Class synopsis

DOMXPath

class DOMXPath {

/* Properties */

public DOMDocument $document ;

/* Methods */

public __construct ( DOMDocument $doc )

public mixed evaluate ( string $expression [, DOMNode $contextnode [, bool $registerNodeNS = true ]] )

public DOMNodeList query ( string $expression [, DOMNode $contextnode [, bool $registerNodeNS = true ]] )

public bool registerNamespace ( string $prefix , string $namespaceURI )

public void registerPhpFunctions ([ mixed $restrict ] )

}

Properties

document

Document Object Model

The DOMAttr class

Introduction

Class synopsis

Properties

See Also

The DOMCdataSection class

Introduction

Class synopsis

The DOMCharacterData class

Introduction

Class synopsis

Properties

See Also

The DOMComment class

Introduction

Class synopsis

See Also

The DOMDocument class

Introduction

Class synopsis

Properties

Notes

See Also

The DOMDocumentFragment class

Class synopsis

The DOMDocumentType class

Introduction

Class synopsis

Properties

The DOMElement class

Class synopsis

Properties

Notes

The DOMEntity class

Introduction

Class synopsis

Properties

The DOMEntityReference class

Class synopsis

The DOMException class

Introduction

Class synopsis

Properties

The DOMImplementation class

Introduction

Class synopsis

The DOMNamedNodeMap class

Class synopsis

Properties

The DOMNode class

Class synopsis

Properties

Notes

Changelog

See Also

The DOMNodeList class

Class synopsis

Properties

See Also

The DOMNotation class

Class synopsis

Properties

The DOMProcessingInstruction class

Class synopsis

Properties

The DOMText class

Introduction

Class synopsis

Properties

The DOMXPath class

Introduction

Class synopsis

Properties