Dom\HTMLDocument | PHP Jetbrains phpstorm-stubs

Since: 8.4

final class HTMLDocument extends Document (View source)

Constants

DOCUMENT_POSITION_DISCONNECTED
DOCUMENT_POSITION_PRECEDING
DOCUMENT_POSITION_FOLLOWING
DOCUMENT_POSITION_CONTAINS
DOCUMENT_POSITION_CONTAINED_BY
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Properties

int	$nodeType	from Node
string	$nodeName	from Node
string	$baseURI	from Node
bool	$isConnected	from Node
Document\|null	$ownerDocument	from Node
Node\|null	$parentNode	from Node
Element\|null	$parentElement	from Node
Node>	$childNodes	from Node
Node\|null	$firstChild	from Node
Node\|null	$lastChild	from Node
Node\|null	$previousSibling	from Node
Node\|null	$nextSibling	from Node
string\|null	$nodeValue	from Node
string\|null	$textContent	from Node
Implementation read-only	$implementation	from Document
string	$URL	from Document
string	$documentURI	from Document
string	$characterSet	from Document
string	$charset	from Document
string	$inputEncoding	from Document
DocumentType\|null	$doctype	from Document
Element\|null	$documentElement	from Document
HTMLCollection Since: 8.5	$children	from Document
Element\|null	$firstElementChild	from Document
Element\|null	$lastElementChild	from Document
int	$childElementCount	from Document
HTMLElement\|null	$body	from Document
HTMLElement\|null	$head	from Document
string	$title	from Document

Methods

Node

getRootNode(array $options = [])

No description

from Node

bool

hasChildNodes()

No description

from Node

void

normalize()

No description

from Node

Node

cloneNode(bool $deep = false)

No description

from Node

bool

isEqualNode(Node|null $otherNode)

No description

from Node

bool

isSameNode(Node|null $otherNode)

No description

from Node

int

compareDocumentPosition(Node $other)

No description

from Node

bool

contains(Node|null $other)

No description

from Node

string|null

lookupPrefix(string|null $namespace)

No description

from Node

string|null

lookupNamespaceURI(string|null $prefix)

No description

from Node

bool

isDefaultNamespace(string|null $namespace)

No description

from Node

Node

insertBefore(Node $node, Node|null $child)

No description

from Node

Node

appendChild(Node $node)

No description

from Node

Node

replaceChild(Node $node, Node $child)

No description

from Node

Node

removeChild(Node $child)

No description

from Node

int

getLineNo()

No description

from Node

string

getNodePath()

No description

from Node

string|false

C14N(bool $exclusive = false, bool $withComments = false, array|null $xpath = null, array|null $nsPrefixes = null)

No description

from Node

int|false

C14NFile(string $uri, bool $exclusive = false, bool $withComments = false, array|null $xpath = null, array|null $nsPrefixes = null)

No description

from Node

array

__sleep()

No description

from Node

void

__wakeup()

No description

from Node

HTMLCollection

getElementsByTagName(string $qualifiedName)

No description

from Document

HTMLCollection

getElementsByTagNameNS(string|null $namespace, string $localName)

No description

from Document

Element

createElement(string $localName)

No description

from Document

Element

createElementNS(string|null $namespace, string $qualifiedName)

No description

from Document

DocumentFragment

createDocumentFragment()

No description

from Document

Text

createTextNode(string $data)

No description

from Document

CDATASection

createCDATASection(string $data)

No description

from Document

Comment

createComment(string $data)

No description

from Document

ProcessingInstruction

createProcessingInstruction(string $target, string $data)

No description

from Document

Node

importNode(Node|null $node, bool $deep = false)

No description

from Document

Node

adoptNode(Node $node)

No description

from Document

Attr

createAttribute(string $localName)

No description

from Document

Attr

createAttributeNS(string|null $namespace, string $qualifiedName)

No description

from Document

Element|null

getElementById(string $elementId)

No description

from Document

void

registerNodeClass(string $baseClass, string|null $extendedClass)

No description

from Document

bool

schemaValidate(string $filename, int $flags = 0)

No description

from Document

bool

schemaValidateSource(string $source, int $flags = 0)

No description

from Document

bool

relaxNgValidate(string $filename)

No description

from Document

bool

relaxNgValidateSource(string $source)

No description

from Document

void

append(Node|string ...$nodes)

Appends nodes after the last child node

from Document

void

prepend(Node|string ...$nodes)

Prepends nodes before the first child node

from Document

void

replaceChildren(Node|string ...$nodes)

Replace children in node

from Document

Node

importLegacyNode(DOMNode $node, bool $deep = false)

No description

from Document

Element|null

querySelector(string $selectors)

Returns the first element that matches the CSS selectors

from Document

NodeList

querySelectorAll(string $selectors)

No description

from Document

HTMLCollection

getElementsByClassName(string $classNames)

No description

from Document

static HTMLDocument

createEmpty(string $encoding = "UTF-8")

Creates an empty HTML document

static HTMLDocument

createFromFile(string $path, int $options = 0, string|null $overrideEncoding = null)

Parses an HTML document from a file

static HTMLDocument

createFromString(string $source, int $options = 0, string|null $overrideEncoding = null)

Parses an HTML document from a string

string|false

saveXml(Node|null $node = null, int $options = 0)

Serializes the document as an XML string

int|false

saveXmlFile(string $filename, int $options = 0)

Serializes the document as an XML file

string

saveHtml(Node|null $node = null)

Serializes the document as an HTML string

int|false

saveHtmlFile(string $filename)

Serializes the document as an HTML file

Details

in Node at line 362
`Node getRootNode(array $options = [])`

No description

Parameters

array

$options

Return Value

Node

in Node at line 366
`bool hasChildNodes()`

No description

Return Value

bool

Node	$node
Node\|null	$child

Return Value

Node

in Node at line 403
`Node appendChild(Node $node)`

No description

Parameters

Node

$node

Return Value

Node

in Node at line 405
`Node replaceChild(Node $node, Node $child)`

No description

Parameters

Node	$node
Node	$child

Return Value

Node

in Node at line 407
`Node removeChild(Node $child)`

No description

Parameters

Node

Return Value

HTMLCollection

in Document at line 470
`HTMLCollection getElementsByTagNameNS(string|null $namespace, string $localName)`

No description

Parameters

string\|null	$namespace
string	$localName

Return Value

HTMLCollection

in Document at line 472
`Element createElement(string $localName)`

No description

Parameters

string

Return Value

Text

in Document at line 480
`CDATASection createCDATASection(string $data)`

No description

Parameters

string

$data

Return Value

CDATASection

in Document at line 482
`Comment createComment(string $data)`

No description

Parameters

string

Node

$node

Return Value

Node

in Document at line 490
`Attr createAttribute(string $localName)`

No description

Parameters

string

$localName

Return Value

Attr

in Document at line 492
`Attr createAttributeNS(string|null $namespace, string $qualifiedName)`

No description

Parameters

string\|null	$namespace
string	$qualifiedName

Return Value

Attr

in Document at line 497
`Element|null getElementById(string $elementId)`

No description

Parameters

string

string

$filename

Return Value

bool

in Document at line 507
`bool relaxNgValidateSource(string $source)`

No description

Parameters

string

$source

Return Value

bool

in Document at line 509
`void append(Node|string ...$nodes)`

Appends nodes after the last child node

Appends one or many nodes to the list of children after the last child node.

Parameters

Node|string

...$nodes

The nodes to append. Strings are automatically converted to text nodes.

Return Value

void	No value is returned.

in Document at line 511
`void prepend(Node|string ...$nodes)`

Prepends nodes before the first child node

Prepends one or many nodes to the list of children before the first child node.

Parameters

Node|string

...$nodes

The nodes to prepend. Strings are automatically converted to text nodes.

Return Value

void	No value is returned.

in Document at line 513
`void replaceChildren(Node|string ...$nodes)`

Replace children in node

Parameters

Node|string

...$nodes

The nodes replacing the children. Strings are automatically converted to text nodes.

Return Value

void	No value is returned.

in Document at line 515
`Node importLegacyNode(DOMNode $node, bool $deep = false)`

No description

Parameters

DOMNode	$node
bool	$deep

Return Value

Node

in Document at line 517
`Element|null querySelector(string $selectors)`

Returns the first element that matches the CSS selectors

Returns the first element that matches the CSS selectors specified in selectors.

Parameters

string

$selectors

A string containing one or more CSS selectors.

Return Value

Element|null

Returns the first Dom\Element that matches selectors. Returns null if no element matches.

in Document at line 520
`NodeList querySelectorAll(string $selectors)`

No description

Parameters

string

$selectors

Return Value

NodeList

in Document at line 525
`HTMLCollection getElementsByClassName(string $classNames)`

Since: 8.5

No description

Parameters

string

$classNames

Return Value

HTMLCollection

at line 545
`static HTMLDocument createEmpty(string $encoding = "UTF-8")`

Creates an empty HTML document

Creates an empty HTML document without any elements.

Parameters

string

$encoding

The character encoding of the document, used for serialization when calling the save methods.

Return Value

HTMLDocument

An empty HTML document.

at line 561
`static HTMLDocument createFromFile(string $path, int $options = 0, string|null $overrideEncoding = null)`

Parses an HTML document from a file

Parses an HTML document from a file, according to the living standard.

Parameters

string	$path	The path to the file to parse.
int	$options	Bitwise OR of the libxml option constants. It is also possible to pass Dom\HTML_NO_DEFAULT_NS to disable the use of the HTML namespace and the template element. This should only be used if the implications are properly understood.
string\|null	$overrideEncoding	The encoding that the document was created in. If not provided, it will attempt to determine the encoding that is most likely used.

Return Value

HTMLDocument

The parsed document as an Dom\HTMLDocument instance.

at line 577
`static HTMLDocument createFromString(string $source, int $options = 0, string|null $overrideEncoding = null)`

Parses an HTML document from a string

Parses an HTML document from a string, according to the living standard.

Parameters

string	$source	The string containing the HTML to parse.
int	$options	Bitwise OR of the libxml option constants. It is also possible to pass Dom\HTML_NO_DEFAULT_NS to disable the use of the HTML namespace and the template element. This should only be used if the implications are properly understood.
string\|null	$overrideEncoding	The encoding that the document was created in. If not provided, it will attempt to determine the encoding that is most likely used.

Return Value

HTMLDocument

The parsed document as an Dom\HTMLDocument instance.

at line 589
`string|false saveXml(Node|null $node = null, int $options = 0)`

Serializes the document as an XML string

Parameters

Node\|null	$node	The node to serialize. If not provided, the entire document is serialized.
int	$options	Additional Options. The LIBXML_NOEMPTYTAG and LIBXML_NOXMLDECL options are supported. Prior to PHP 8.3.0, only the LIBXML_NOEMPTYTAG option is supported.

Return Value

string|false

The serialized XML document string in the current document encoding, or false on failure.

at line 599
`int|false saveXmlFile(string $filename, int $options = 0)`

Serializes the document as an XML file

Parameters

string	$filename	The path to the file to save to.
int	$options	Additional Options. The LIBXML_NOEMPTYTAG and LIBXML_NOXMLDECL options are supported. Prior to PHP 8.3.0, only the LIBXML_NOEMPTYTAG option is supported.

Return Value

int|false

The number of bytes written on success, or false on failure.

at line 608
`string saveHtml(Node|null $node = null)`

Serializes the document as an HTML string

Parameters

Node|null

$node

The node to serialize. If not provided, the entire document is serialized.

Return Value

string

The serialized HTML document string in the current document encoding.

at line 616
`int|false saveHtmlFile(string $filename)`

Serializes the document as an HTML file

Parameters

string

$filename

The path to the file to save to.

Return Value

int|false

The number of bytes written on success, or false on failure.

HTMLDocument

Constants

Properties

Methods

Details

in Node at line 362 Node getRootNode(array $options = [])

Parameters

Return Value

in Node at line 366 bool hasChildNodes()

Return Value

in Node at line 377 void normalize()

Return Value

in Node at line 379 Node cloneNode(bool $deep = false)

Parameters

Return Value

in Node at line 381 bool isEqualNode(Node|null $otherNode)

Parameters

Return Value

in Node at line 383 bool isSameNode(Node|null $otherNode)

Parameters

Return Value

in Node at line 391 int compareDocumentPosition(Node $other)

Parameters

Return Value

in Node at line 393 bool contains(Node|null $other)

Parameters

Return Value

in Node at line 395 string|null lookupPrefix(string|null $namespace)

Parameters

Return Value

in Node at line 397 string|null lookupNamespaceURI(string|null $prefix)

Parameters

Return Value

in Node at line 399 bool isDefaultNamespace(string|null $namespace)

Parameters

Return Value

in Node at line 401 Node insertBefore(Node $node, Node|null $child)

Parameters

Return Value

in Node at line 403 Node appendChild(Node $node)

Parameters

Return Value

in Node at line 405 Node replaceChild(Node $node, Node $child)

Parameters

Return Value

in Node at line 407 Node removeChild(Node $child)

Parameters

Return Value

in Node at line 409 int getLineNo()

Return Value

in Node at line 411 string getNodePath()

Return Value

in Node at line 413 string|false C14N(bool $exclusive = false, bool $withComments = false, array|null $xpath = null, array|null $nsPrefixes = null)

Parameters

Return Value

in Node at line 415 int|false C14NFile(string $uri, bool $exclusive = false, bool $withComments = false, array|null $xpath = null, array|null $nsPrefixes = null)

Parameters

Return Value

in Node at line 417 array __sleep()

Return Value

in Node at line 419 void __wakeup()

Return Value

in Document at line 468 HTMLCollection getElementsByTagName(string $qualifiedName)

Parameters

Return Value

in Document at line 470 HTMLCollection getElementsByTagNameNS(string|null $namespace, string $localName)

Parameters

Return Value

in Document at line 472 Element createElement(string $localName)

Parameters

Return Value

in Document at line 474 Element createElementNS(string|null $namespace, string $qualifiedName)

Parameters

Return Value

in Document at line 476 DocumentFragment createDocumentFragment()

Return Value

in Document at line 478 Text createTextNode(string $data)

Parameters

Return Value

in Document at line 480 CDATASection createCDATASection(string $data)

in Node at line 362
`Node getRootNode(array $options = [])`

in Node at line 366
`bool hasChildNodes()`

in Node at line 377
`void normalize()`

in Node at line 379
`Node cloneNode(bool $deep = false)`

in Node at line 381
`bool isEqualNode(Node|null $otherNode)`

in Node at line 383
`bool isSameNode(Node|null $otherNode)`

in Node at line 391
`int compareDocumentPosition(Node $other)`

in Node at line 393
`bool contains(Node|null $other)`

in Node at line 395
`string|null lookupPrefix(string|null $namespace)`

in Node at line 397
`string|null lookupNamespaceURI(string|null $prefix)`

in Node at line 399
`bool isDefaultNamespace(string|null $namespace)`

in Node at line 401
`Node insertBefore(Node $node, Node|null $child)`

in Node at line 403
`Node appendChild(Node $node)`

in Node at line 405
`Node replaceChild(Node $node, Node $child)`

in Node at line 407
`Node removeChild(Node $child)`

in Node at line 409
`int getLineNo()`

in Node at line 411
`string getNodePath()`

in Node at line 413
`string|false C14N(bool $exclusive = false, bool $withComments = false, array|null $xpath = null, array|null $nsPrefixes = null)`

in Node at line 415
`int|false C14NFile(string $uri, bool $exclusive = false, bool $withComments = false, array|null $xpath = null, array|null $nsPrefixes = null)`

in Node at line 417
`array __sleep()`

in Node at line 419
`void __wakeup()`

in Document at line 468
`HTMLCollection getElementsByTagName(string $qualifiedName)`

in Document at line 470
`HTMLCollection getElementsByTagNameNS(string|null $namespace, string $localName)`

in Document at line 472
`Element createElement(string $localName)`

in Document at line 474
`Element createElementNS(string|null $namespace, string $qualifiedName)`

in Document at line 476
`DocumentFragment createDocumentFragment()`

in Document at line 478
`Text createTextNode(string $data)`

in Document at line 480
`CDATASection createCDATASection(string $data)`

in Document at line 482
`Comment createComment(string $data)`

in Document at line 484
`ProcessingInstruction createProcessingInstruction(string $target, string $data)`

in Document at line 486
`Node importNode(Node|null $node, bool $deep = false)`

in Document at line 488
`Node adoptNode(Node $node)`

in Document at line 490
`Attr createAttribute(string $localName)`

in Document at line 492
`Attr createAttributeNS(string|null $namespace, string $qualifiedName)`

in Document at line 497
`Element|null getElementById(string $elementId)`

in Document at line 499
`void registerNodeClass(string $baseClass, string|null $extendedClass)`

in Document at line 501
`bool schemaValidate(string $filename, int $flags = 0)`

in Document at line 503
`bool schemaValidateSource(string $source, int $flags = 0)`

in Document at line 505
`bool relaxNgValidate(string $filename)`

in Document at line 507
`bool relaxNgValidateSource(string $source)`

in Document at line 509
`void append(Node|string ...$nodes)`

in Document at line 511
`void prepend(Node|string ...$nodes)`

in Document at line 513
`void replaceChildren(Node|string ...$nodes)`

in Document at line 515
`Node importLegacyNode(DOMNode $node, bool $deep = false)`

in Document at line 517
`Element|null querySelector(string $selectors)`

in Document at line 520
`NodeList querySelectorAll(string $selectors)`

in Document at line 525
`HTMLCollection getElementsByClassName(string $classNames)`

at line 545
`static HTMLDocument createEmpty(string $encoding = "UTF-8")`

at line 561
`static HTMLDocument createFromFile(string $path, int $options = 0, string|null $overrideEncoding = null)`

at line 577
`static HTMLDocument createFromString(string $source, int $options = 0, string|null $overrideEncoding = null)`

at line 589
`string|false saveXml(Node|null $node = null, int $options = 0)`