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)

No description

from Document

void

prepend(Node|string ...$nodes)

No description

from Document

void

replaceChildren(Node|string ...$nodes)

No description

from Document

Node

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

No description

from Document

Element|null

querySelector(string $selectors)

No description

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

No description

static HTMLDocument

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

No description

static HTMLDocument

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

No description

string|false

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

No description

int|false

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

No description

string

saveHtml(Node|null $node = null)

No description

int|false

saveHtmlFile(string $filename)

No description

int

debugGetTemplateCount()

No description

Details

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

No description

Parameters

array

$options

Return Value

Node

in Node at line 224
`bool hasChildNodes()`

No description

Return Value

bool

in Node at line 235
`void normalize()`

No description

Return Value

void

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

No description

Parameters

bool

$deep

Return Value

Node

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

No description

Parameters

Node|null

$otherNode

Return Value

bool

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

No description

Parameters

Node|null

$otherNode

Return Value

bool

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

No description

Parameters

Node

$other

Return Value

int

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

No description

Parameters

Node|null

$other

Return Value

bool

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

No description

Parameters

string|null

$namespace

Return Value

string|null

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

No description

Parameters

string|null

$prefix

Return Value

string|null

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

No description

Parameters

string|null

$namespace

Return Value

bool

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

No description

Parameters

Node	$node
Node\|null	$child

Return Value

Node

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

No description

Parameters

Node

$node

Return Value

Node

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

No description

Parameters

Node	$node
Node	$child

Return Value

Node

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

No description

Parameters

Node

$child

Return Value

Node

in Node at line 267
`int getLineNo()`

No description

Return Value

int

in Node at line 269
`string getNodePath()`

No description

Return Value

string

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

No description

Parameters

bool	$exclusive
bool	$withComments
array\|null	$xpath
array\|null	$nsPrefixes

Return Value

string|false

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

No description

Parameters

string	$uri
bool	$exclusive
bool	$withComments
array\|null	$xpath
array\|null	$nsPrefixes

Return Value

int|false

in Node at line 275
`array __sleep()`

No description

Return Value

array

in Node at line 277
`void __wakeup()`

No description

Return Value

void

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

No description

Parameters

string

$qualifiedName

Return Value

HTMLCollection

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

No description

Parameters

string\|null	$namespace
string	$localName

Return Value

HTMLCollection

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

No description

Parameters

string

$localName

Return Value

Element

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

No description

Parameters

string\|null	$namespace
string	$qualifiedName

Return Value

Element

in Document at line 334
`DocumentFragment createDocumentFragment()`

No description

Return Value

DocumentFragment

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

No description

Parameters

string

$data

Return Value

Text

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

No description

Parameters

string

$data

Return Value

CDATASection

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

No description

Parameters

string

$data

Return Value

Comment

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

No description

Parameters

string	$target
string	$data

Return Value

ProcessingInstruction

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

No description

Parameters

Node\|null	$node
bool	$deep

Return Value

Node

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

No description

Parameters

Node

$node

Return Value

Node

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

No description

Parameters

string

$localName

Return Value

Attr

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

No description

Parameters

string\|null	$namespace
string	$qualifiedName

Return Value

Attr

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

No description

Parameters

string

$elementId

Return Value

Element|null

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

No description

Parameters

string	$baseClass
string\|null	$extendedClass

Return Value

void

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

No description

Parameters

string	$filename
int	$flags

Return Value

bool

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

No description

Parameters

string	$source
int	$flags

Return Value

bool

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

No description

Parameters

string

$filename

Return Value

bool

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

No description

Parameters

string

$source

Return Value

bool

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

No description

Parameters

Node|string

...$nodes

Return Value

void

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

No description

Parameters

Node|string

...$nodes

Return Value

void

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

No description

Parameters

Node|string

...$nodes

Return Value

void

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

No description

Parameters

DOMNode	$node
bool	$deep

Return Value

Node

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

No description

Parameters

string

$selectors

Return Value

Element|null

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

No description

Parameters

string

$selectors

Return Value

NodeList

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

Since: 8.5

No description

Parameters

string

$classNames

Return Value

HTMLCollection

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

No description

Parameters

string

$encoding

Return Value

HTMLDocument

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

No description

Parameters

string	$path
int	$options
string\|null	$overrideEncoding

Return Value

HTMLDocument

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

No description

Parameters

string	$source
int	$options
string\|null	$overrideEncoding

Return Value

HTMLDocument

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

No description

Parameters

Node\|null	$node
int	$options

Return Value

string|false

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

No description

Parameters

string	$filename
int	$options

Return Value

int|false

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

No description

Parameters

Node|null

$node

Return Value

string

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

No description

Parameters

string

$filename

Return Value

int|false

at line 407
`int debugGetTemplateCount()`

No description

Return Value

int

HTMLDocument

Constants

Properties

Methods

Details

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

Parameters

Return Value

in Node at line 224 bool hasChildNodes()

Return Value

in Node at line 235 void normalize()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in Node at line 267 int getLineNo()

Return Value

in Node at line 269 string getNodePath()

Return Value

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

Parameters

Return Value

in Node at line 273 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 275 array __sleep()

Return Value

in Node at line 277 void __wakeup()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in Document at line 334 DocumentFragment createDocumentFragment()

Return Value

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

Parameters

Return Value

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

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

in Node at line 224
`bool hasChildNodes()`

in Node at line 235
`void normalize()`

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

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

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

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

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

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

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

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

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

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

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

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

in Node at line 267
`int getLineNo()`

in Node at line 269
`string getNodePath()`

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

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

in Node at line 275
`array __sleep()`

in Node at line 277
`void __wakeup()`

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

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

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

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

in Document at line 334
`DocumentFragment createDocumentFragment()`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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