DOMComment::__construct
DOMDocument::__construct
DOM
PHP Manual

# 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 */
__construct ([ string `$version` [, string `$encoding` ]] )
DOMAttr createAttribute ( string `$name` )
DOMAttr createAttributeNS ( string `$namespaceURI` , string `$qualifiedName` )
DOMCDATASection createCDATASection ( string `$data` )
DOMComment createComment ( string `$data` )
DOMDocumentFragment createDocumentFragment ( void )
DOMElement createElement ( string `$name` [, string `$value` ] )
DOMElement createElementNS ( string `$namespaceURI` , string `$qualifiedName` [, string `$value` ] )
DOMEntityReference createEntityReference ( string `$name` )
DOMProcessingInstruction createProcessingInstruction ( string `$target` [, string `$data` ] )
DOMText createTextNode ( string `$content` )
DOMElement getElementById ( string `$elementId` )
DOMNodeList getElementsByTagName ( string `$name` )
DOMNodeList getElementsByTagNameNS ( string `$namespaceURI` , string `$localName` )
DOMNode importNode ( DOMNode `$importedNode` [, bool `$deep` ] )
mixed load ( string `$filename` [, int `$options` ] )
bool loadHTML ( string `$source` )
bool loadHTMLFile ( string `$filename` )
mixed loadXML ( string `$source` [, int `$options` ] )
void normalizeDocument ( void )
bool registerNodeClass ( string `$baseclass` , string `$extendedclass` )
bool relaxNGValidate ( string `$filename` )
bool relaxNGValidateSource ( string `$source` )
int save ( string `$filename` [, int `$options` ] )
string saveHTML ( void )
int saveHTMLFile ( string `$filename` )
string saveXML ([ DOMNode `$node` [, int `$options` ]] )
bool schemaValidate ( string `$filename` )
bool schemaValidateSource ( string `$source` )
bool validate ( void )
int xinclude ([ int `$options` ] )
/* Inherited methods */
DOMNode DOMNode::appendChild ( DOMNode `$newnode` )
DOMNode DOMNode::cloneNode ([ bool `$deep` ] )
bool DOMNode::hasAttributes ( void )
bool DOMNode::hasChildNodes ( void )
DOMNode DOMNode::insertBefore ( DOMNode `$newnode` [, DOMNode `$refnode` ] )
bool DOMNode::isDefaultNamespace ( string `$namespaceURI` )
bool DOMNode::isSameNode ( DOMNode `$node` )
bool DOMNode::isSupported ( string `$feature` , string `$version` )
string DOMNode::lookupNamespaceURI ( string `$prefix` )
string DOMNode::lookupPrefix ( string `$namespaceURI` )
void DOMNode::normalize ( void )
DOMNode DOMNode::removeChild ( DOMNode `$oldnode` )
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".

## See Also

- » W3C specification for Document

## Table of Contents

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

DOMComment::__construct
DOMDocument::__construct
DOM
PHP Manual