1. class
  2. Dom
  3. \
  4. Element

Element

Since: 8.4

class Element extends Node implements ParentNode, ChildNode (View source)

Represents an element.

This is the modern, spec-compliant equivalent of DOMElement.

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
string|null $namespaceURI
string|null $prefix
string $localName
string $tagName
string $id
string $className
HTMLCollection Since: 8.5
$children
TokenList read-only $classList
NamedNodeMap $attributes
Element|null $firstElementChild
Element|null $lastElementChild
int $childElementCount
Element|null $previousElementSibling
Element|null $nextElementSibling
string $innerHTML
string $outerHTML
string $substitutedNodeValue

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
bool
hasAttributes()

No description

array
getAttributeNames()

No description

string|null
getAttribute(string $qualifiedName)

No description

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

No description

void
setAttribute(string $qualifiedName, string $value)

No description

void
setAttributeNS(string|null $namespace, string $qualifiedName, string $value)

No description

void
removeAttribute(string $qualifiedName)

No description

void
removeAttributeNS(string|null $namespace, string $localName)

No description

bool
toggleAttribute(string $qualifiedName, bool|null $force = null)

No description

bool
hasAttribute(string $qualifiedName)

No description

bool
hasAttributeNS(string|null $namespace, string $localName)

No description

Attr|null
getAttributeNode(string $qualifiedName)

No description

Attr|null
getAttributeNodeNS(string|null $namespace, string $localName)

No description

Attr|null
setAttributeNode(Attr $attr)

No description

Attr|null
setAttributeNodeNS(Attr $attr)

No description

Attr
removeAttributeNode(Attr $attr)

No description

HTMLCollection
getElementsByTagName(string $qualifiedName)

No description

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

No description

Element|null
insertAdjacentElement(AdjacentPosition $where, Element $element)

No description

void
insertAdjacentText(AdjacentPosition $where, string $data)

No description

void
setIdAttribute(string $qualifiedName, bool $isId)

No description

void
setIdAttributeNS(string|null $namespace, string $qualifiedName, bool $isId)

No description

void
setIdAttributeNode(Attr $attr, bool $isId)

No description

void
remove()

Removes the node

void
before(Node|string ...$nodes)

Adds nodes before the node

void
after(Node|string ...$nodes)

Adds nodes after the node

void
replaceWith(Node|string ...$nodes)

Replaces the node with new nodes

void
append(Node|string ...$nodes)

Appends nodes after the last child node

void
prepend(Node|string ...$nodes)

Prepends nodes before the first child node

void
replaceChildren(Node|string ...$nodes)

Replace children in node

Element|null
querySelector(string $selectors)

Returns the first element that matches the CSS selectors

NodeList
querySelectorAll(string $selectors)

No description

Element|null
closest(string $selectors)

No description

bool
matches(string $selectors)

No description

array
getInScopeNamespaces()

No description

array
getDescendantNamespaces()

No description

void
rename(string|null $namespaceURI, string $qualifiedName)

No description

HTMLCollection
getElementsByClassName(string $classNames)

No description

void
insertAdjacentHTML(AdjacentPosition $where, string $string)

No description

Details

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

No description

Parameters

array $options

Return Value

Node

in Node at line 427
bool hasChildNodes()

No description

Return Value

bool

in Node at line 438
void normalize()

No description

Return Value

void

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

No description

Parameters

bool $deep

Return Value

Node

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

No description

Parameters

Node|null $otherNode

Return Value

bool

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

No description

Parameters

Node|null $otherNode

Return Value

bool

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

No description

Parameters

Node $other

Return Value

int

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

No description

Parameters

Node|null $other

Return Value

bool

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

No description

Parameters

string|null $namespace

Return Value

string|null

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

No description

Parameters

string|null $prefix

Return Value

string|null

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

No description

Parameters

string|null $namespace

Return Value

bool

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

No description

Parameters

Node $node
Node|null $child

Return Value

Node

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

No description

Parameters

Node $node

Return Value

Node

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

No description

Parameters

Node $node
Node $child

Return Value

Node

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

No description

Parameters

Node $child

Return Value

Node

in Node at line 470
int getLineNo()

No description

Return Value

int

in Node at line 472
string getNodePath()

No description

Return Value

string

in Node at line 474
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 476
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 478
array __sleep()

No description

Return Value

array

in Node at line 480
void __wakeup()

No description

Return Value

void

at line 915
bool hasAttributes()

No description

Return Value

bool

at line 918
array getAttributeNames()

No description

Return Value

array

at line 920
string|null getAttribute(string $qualifiedName)

No description

Parameters

string $qualifiedName

Return Value

string|null

at line 922
string|null getAttributeNS(string|null $namespace, string $localName)

No description

Parameters

string|null $namespace
string $localName

Return Value

string|null

at line 924
void setAttribute(string $qualifiedName, string $value)

No description

Parameters

string $qualifiedName
string $value

Return Value

void

at line 926
void setAttributeNS(string|null $namespace, string $qualifiedName, string $value)

No description

Parameters

string|null $namespace
string $qualifiedName
string $value

Return Value

void

at line 928
void removeAttribute(string $qualifiedName)

No description

Parameters

string $qualifiedName

Return Value

void

at line 930
void removeAttributeNS(string|null $namespace, string $localName)

No description

Parameters

string|null $namespace
string $localName

Return Value

void

at line 932
bool toggleAttribute(string $qualifiedName, bool|null $force = null)

No description

Parameters

string $qualifiedName
bool|null $force

Return Value

bool

at line 934
bool hasAttribute(string $qualifiedName)

No description

Parameters

string $qualifiedName

Return Value

bool

at line 936
bool hasAttributeNS(string|null $namespace, string $localName)

No description

Parameters

string|null $namespace
string $localName

Return Value

bool

at line 938
Attr|null getAttributeNode(string $qualifiedName)

No description

Parameters

string $qualifiedName

Return Value

Attr|null

at line 940
Attr|null getAttributeNodeNS(string|null $namespace, string $localName)

No description

Parameters

string|null $namespace
string $localName

Return Value

Attr|null

at line 942
Attr|null setAttributeNode(Attr $attr)

No description

Parameters

Attr $attr

Return Value

Attr|null

at line 944
Attr|null setAttributeNodeNS(Attr $attr)

No description

Parameters

Attr $attr

Return Value

Attr|null

at line 946
Attr removeAttributeNode(Attr $attr)

No description

Parameters

Attr $attr

Return Value

Attr

at line 948
HTMLCollection getElementsByTagName(string $qualifiedName)

No description

Parameters

string $qualifiedName

Return Value

HTMLCollection

at line 950
HTMLCollection getElementsByTagNameNS(string|null $namespace, string $localName)

No description

Parameters

string|null $namespace
string $localName

Return Value

HTMLCollection

at line 952
Element|null insertAdjacentElement(AdjacentPosition $where, Element $element)

No description

Parameters

AdjacentPosition $where
Element $element

Return Value

Element|null

at line 954
void insertAdjacentText(AdjacentPosition $where, string $data)

No description

Parameters

AdjacentPosition $where
string $data

Return Value

void

at line 961
void setIdAttribute(string $qualifiedName, bool $isId)

No description

Parameters

string $qualifiedName
bool $isId

Return Value

void

at line 963
void setIdAttributeNS(string|null $namespace, string $qualifiedName, bool $isId)

No description

Parameters

string|null $namespace
string $qualifiedName
bool $isId

Return Value

void

at line 965
void setIdAttributeNode(Attr $attr, bool $isId)

No description

Parameters

Attr $attr
bool $isId

Return Value

void

at line 967
void remove()

Removes the node

Return Value

void

No value is returned.

at line 969
void before(Node|string ...$nodes)

Adds nodes before the node

Adds the passed nodes before the node.

Parameters

Node|string ...$nodes

Nodes to be added before the node. Strings are automatically converted to text nodes.

Return Value

void

No value is returned.

at line 971
void after(Node|string ...$nodes)

Adds nodes after the node

Adds the passed nodes after the node.

Parameters

Node|string ...$nodes

Nodes to be added after the node. Strings are automatically converted to text nodes.

Return Value

void

No value is returned.

at line 973
void replaceWith(Node|string ...$nodes)

Replaces the node with new nodes

Parameters

Node|string ...$nodes

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

Return Value

void

No value is returned.

at line 975
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.

at line 977
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.

at line 979
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.

at line 981
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.

Exceptions

DOMException

at line 984
NodeList querySelectorAll(string $selectors)

No description

Parameters

string $selectors

Return Value

NodeList

Returns a static collection of elements that match the CSS selectors specified in selectors.

at line 986
Element|null closest(string $selectors)

No description

Parameters

string $selectors

Return Value

Element|null

at line 988
bool matches(string $selectors)

No description

Parameters

string $selectors

Return Value

bool

at line 994
array getInScopeNamespaces()

No description

Return Value

array

at line 997
array getDescendantNamespaces()

No description

Return Value

array

at line 999
void rename(string|null $namespaceURI, string $qualifiedName)

No description

Parameters

string|null $namespaceURI
string $qualifiedName

Return Value

void

at line 1004
HTMLCollection getElementsByClassName(string $classNames)

Since: 8.5

No description

Parameters

string $classNames

Return Value

HTMLCollection

at line 1009
void insertAdjacentHTML(AdjacentPosition $where, string $string)

Since: 8.5

No description

Parameters

AdjacentPosition $where
string $string

Return Value

void