DOMElement

class DOMElement extends DOMNode implements DOMParentNode, DOMChildNode (View source)

The DOMElement class

Constants

DOCUMENT_POSITION_DISCONNECTED Since: 8.4

DOCUMENT_POSITION_PRECEDING Since: 8.4

DOCUMENT_POSITION_FOLLOWING Since: 8.4

DOCUMENT_POSITION_CONTAINS Since: 8.4

DOCUMENT_POSITION_CONTAINED_BY Since: 8.4

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC Since: 8.4

Properties

string $nodeName from  DOMNode
string|null $nodeValue from  DOMNode
int $nodeType from  DOMNode
DOMNode|null $parentNode
DOMNode> $childNodes from  DOMNode
DOMNode|null $firstChild
DOMNode|null $lastChild
DOMNode|null $previousSibling
DOMNode|null $nextSibling
DOMAttr> $attributes
DOMDocument|null $ownerDocument from  DOMNode
string|null $namespaceURI from  DOMNode
string|null $prefix from  DOMNode
string|null $localName from  DOMNode
string|null $baseURI from  DOMNode
string $textContent from  DOMNode
bool $isConnected from  DOMNode
DOMElement|null $parentElement from  DOMNode
bool $schemaTypeInfo
string $tagName
$firstElementChild
$lastElementChild
$childElementCount
$previousElementSibling
$nextElementSibling
string $id
string $className

Methods

DOMNode
insertBefore(DOMNode $node, null|DOMNode $child = null)

Adds a new child before a reference node

from  DOMNode
DOMNode|false
replaceChild(DOMNode $node, DOMNode $child)

Replaces a child

from  DOMNode
DOMNode
removeChild(DOMNode $child)

Removes child from list of children

from  DOMNode
DOMNode
appendChild(DOMNode $node)

Adds new child at the end of the children

from  DOMNode
bool
hasChildNodes()

Checks if node has children

from  DOMNode
DOMNode
cloneNode(bool $deep = false)

Clones a node

from  DOMNode
void
normalize()

Normalizes the node

from  DOMNode
bool
isSupported(string $feature, string $version)

Checks if feature is supported for specified version

from  DOMNode
bool
hasAttributes()

Checks if node has attributes

from  DOMNode
int
compareDocumentPosition(DOMNode $other)

No description

from  DOMNode
bool
isSameNode(DOMNode $otherNode)

Indicates if two nodes are the same node

from  DOMNode
string|null
lookupPrefix(string $namespace)

Gets the namespace prefix of the node based on the namespace URI

from  DOMNode
bool
isDefaultNamespace(string $namespace)

Checks if the specified namespaceURI is the default namespace or not

from  DOMNode
string|null
lookupNamespaceURI(string|null $prefix)

Gets the namespace URI of the node based on the prefix

from  DOMNode
string|null
lookupNamespaceUri(string|null $prefix)

Gets the namespace URI of the node based on the prefix

from  DOMNode
bool
isEqualNode($otherNode)

No description

from  DOMNode
getFeature($feature, $version)

No description

from  DOMNode
setUserData($key, $data, $handler)

No description

from  DOMNode
getUserData($key)

No description

from  DOMNode
string|null
getNodePath()

Gets an XPath location path for the node

from  DOMNode
int
getLineNo()

Get line number for a node

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

Canonicalize nodes to a string

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

Canonicalize nodes to a file.

from  DOMNode
bool
contains(DOMNode|DOMNameSpaceNode|null $other)

No description

from  DOMNode
DOMNode
getRootNode(array|null $options = null)

No description

from  DOMNode
array
__sleep()

No description

from  DOMNode
void
__wakeup()

No description

from  DOMNode
string
getAttribute(string $qualifiedName)

Returns value of attribute

DOMAttr|false
setAttribute(string $qualifiedName, string $value)

Adds new attribute

bool
removeAttribute(string $qualifiedName)

Removes attribute

DOMAttr
getAttributeNode(string $qualifiedName)

Returns attribute node

DOMAttr|null
setAttributeNode(DOMAttr $attr)

Adds new attribute node to element

bool
removeAttributeNode(DOMAttr $attr)

Removes attribute

DOMNodeList
getElementsByTagName(string $qualifiedName)

Gets elements by tagname

string
getAttributeNS(string $namespace, string $localName)

Returns value of attribute

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

Adds new attribute

void
removeAttributeNS(string $namespace, string $localName)

Removes attribute

DOMAttr
getAttributeNodeNS(string $namespace, string $localName)

Returns attribute node

DOMAttr
setAttributeNodeNS(DOMAttr $attr)

Adds new attribute node to element

DOMNodeList
getElementsByTagNameNS(string $namespace, string $localName)

Get elements by namespaceURI and localName

bool
hasAttribute(string $qualifiedName)

Checks to see if attribute exists

bool
hasAttributeNS(string $namespace, string $localName)

Checks to see if attribute exists

void
setIdAttribute(string $qualifiedName, bool $isId)

Declares the attribute specified by name to be of type ID

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

Declares the attribute specified by local name and namespace URI to be of type ID

void
setIdAttributeNode(DOMAttr $attr, bool $isId)

Declares the attribute specified by node to be of type ID

void
remove()

Acts as a simpler version of {DOMNode

void
before(DOMNode|string|null ...$nodes)

Add passed node(s) before the current node

void
after(DOMNode|string|null ...$nodes)

Add passed node(s) after the current node

void
replaceWith(DOMNode|string|null ...$nodes)

Replace current node with new node(s), a combination of {DOMChildNode::remove()} + {DOMChildNode::append()}.

void
append(DOMNode|string|null ...$nodes)

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

void
prepend(DOMNode|string|null ...$nodes)

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

void
replaceChildren(...$nodes)

No description

__construct(string $qualifiedName, string|null $value = null, string $namespace = '')

Creates a new DOMElement object

array
getAttributeNames()

No description

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

No description

DOMElement|null
insertAdjacentElement(string $where, DOMElement $element)

No description

void
insertAdjacentText(string $where, string $data)

No description

Details

in DOMNode at line 174
DOMNode insertBefore(DOMNode $node, null|DOMNode $child = null)

Adds a new child before a reference node

Parameters

DOMNode $node

The new node.

null|DOMNode $child

[optional]

The reference node. If not supplied, newnode is appended to the children.

Return Value

DOMNode

The inserted node.

in DOMNode at line 192
DOMNode|false replaceChild(DOMNode $node, DOMNode $child)

Replaces a child

Parameters

DOMNode $node

The new node. It must be a member of the target document, i.e. created by one of the DOMDocument->createXXX() methods or imported in the document by .

DOMNode $child

The old node.

Return Value

DOMNode|false

The old node or false if an error occur.

in DOMNode at line 202
DOMNode removeChild(DOMNode $child)

Removes child from list of children

Parameters

DOMNode $child

The removed child.

Return Value

DOMNode

If the child could be removed the functions returns the old child.

in DOMNode at line 212
DOMNode appendChild(DOMNode $node)

Adds new child at the end of the children

Parameters

DOMNode $node

The appended child.

Return Value

DOMNode

The node added.

in DOMNode at line 219
bool hasChildNodes()

Checks if node has children

Return Value

bool

true on success or false on failure.

in DOMNode at line 231
DOMNode cloneNode(bool $deep = false)

Clones a node

Parameters

bool $deep

Indicates whether to copy all descendant nodes. This parameter is defaulted to false.

Return Value

DOMNode

The cloned node.

in DOMNode at line 241
void normalize()

Normalizes the node

Return Value

void

in DOMNode at line 257
bool isSupported(string $feature, string $version)

Checks if feature is supported for specified version

Parameters

string $feature

The feature to test. See the example of DOMImplementation::hasFeature for a list of features.

string $version

The version number of the feature to test.

Return Value

bool

true on success or false on failure.

in DOMNode at line 268
bool hasAttributes()

Checks if node has attributes

Return Value

bool

true on success or false on failure.

in DOMNode at line 274
int compareDocumentPosition(DOMNode $other)

No description

Parameters

DOMNode $other

Return Value

int

in DOMNode at line 285
bool isSameNode(DOMNode $otherNode)

Indicates if two nodes are the same node

Parameters

DOMNode $otherNode

The compared node.

Return Value

bool

true on success or false on failure.

in DOMNode at line 296
string|null lookupPrefix(string $namespace)

Gets the namespace prefix of the node based on the namespace URI

Parameters

string $namespace

The namespace URI.

Return Value

string|null

The prefix of the namespace.

in DOMNode at line 308
bool isDefaultNamespace(string $namespace)

Checks if the specified namespaceURI is the default namespace or not

Parameters

string $namespace

The namespace URI to look for.

Return Value

bool

Return true if namespaceURI is the default namespace, false otherwise.

in DOMNode at line 319
string|null lookupNamespaceURI(string|null $prefix)

Gets the namespace URI of the node based on the prefix

Parameters

string|null $prefix

The prefix of the namespace.

Return Value

string|null

The namespace URI of the node.

in DOMNode at line 331
string|null lookupNamespaceUri(string|null $prefix)

Gets the namespace URI of the node based on the prefix

Parameters

string|null $prefix

The prefix of the namespace.

Return Value

string|null

The namespace URI of the node.

in DOMNode at line 338
bool isEqualNode($otherNode)

No description

Parameters

$otherNode

Return Value

bool

in DOMNode at line 344
getFeature($feature, $version)

No description

Parameters

$feature
$version

in DOMNode at line 349
setUserData($key, $data, $handler)

No description

Parameters

$key
$data
$handler

in DOMNode at line 354
getUserData($key)

No description

Parameters

$key

in DOMNode at line 361
string|null getNodePath()

Gets an XPath location path for the node

Return Value

string|null

the XPath, or NULL in case of an error.

in DOMNode at line 369
int getLineNo()

Get line number for a node

Return Value

int

Always returns the line number where the node was defined in.

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

Canonicalize nodes to a string

Parameters

bool $exclusive

[optional] Enable exclusive parsing of only the nodes matched by the provided xpath or namespace prefixes.
bool $withComments

[optional] Retain comments in output.
null|array $xpath

[optional] An array of xpaths to filter the nodes by.
null|array $nsPrefixes

[optional] An array of namespace prefixes to filter the nodes by.

Return Value

string|false

Canonicalized nodes as a string or FALSE on failure

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

Canonicalize nodes to a file.

Parameters

string $uri

Number of bytes written or FALSE on failure
bool $exclusive

[optional] Enable exclusive parsing of only the nodes matched by the provided xpath or namespace prefixes.
bool $withComments

[optional] Retain comments in output.
null|array $xpath

[optional] An array of xpaths to filter the nodes by.
null|array $nsPrefixes

[optional] An array of namespace prefixes to filter the nodes by.

Return Value

int|false

Number of bytes written or FALSE on failure

in DOMNode at line 410
bool contains(DOMNode|DOMNameSpaceNode|null $other)

Since: 8.3

No description

Parameters

DOMNode|DOMNameSpaceNode|null $other

Return Value

bool

in DOMNode at line 415
DOMNode getRootNode(array|null $options = null)

Since: 8.3

No description

Parameters

array|null $options

Return Value

DOMNode

in DOMNode at line 420
array __sleep()

Since: 8.1

No description

Return Value

array

in DOMNode at line 425
void __wakeup()

Since: 8.1

No description

Return Value

void

at line 1772
string getAttribute(string $qualifiedName)

Returns value of attribute

Parameters

string $qualifiedName

The name of the attribute.

Return Value

string

The value of the attribute, or an empty string if no attribute with the given name is found.

at line 1786
DOMAttr|false setAttribute(string $qualifiedName, string $value)

Adds new attribute

Parameters

string $qualifiedName

The name of the attribute.

string $value

The value of the attribute.

Return Value

DOMAttr|false

The new DOMAttr or false if an error occurred.

at line 1799
bool removeAttribute(string $qualifiedName)

Removes attribute

Parameters

string $qualifiedName

The name of the attribute.

Return Value

bool

true on success or false on failure.

at line 1810
DOMAttr getAttributeNode(string $qualifiedName)

Returns attribute node

Parameters

string $qualifiedName

The name of the attribute.

Return Value

DOMAttr

The attribute node.

at line 1820
DOMAttr|null setAttributeNode(DOMAttr $attr)

Adds new attribute node to element

Parameters

DOMAttr $attr

The attribute node.

Return Value

DOMAttr|null

Old node if the attribute has been replaced or null.

at line 1830
bool removeAttributeNode(DOMAttr $attr)

Removes attribute

Parameters

DOMAttr $attr

The attribute node.

Return Value

bool

true on success or false on failure.

at line 1842
DOMNodeList getElementsByTagName(string $qualifiedName)

Gets elements by tagname

Parameters

string $qualifiedName

The tag name. Use * to return all elements within the element tree.

Return Value

DOMNodeList

This function returns a new instance of the class DOMNodeList of all matched elements.

at line 1858
string getAttributeNS(string $namespace, string $localName)

Returns value of attribute

Parameters

string $namespace

The namespace URI.

string $localName

The local name.

Return Value

string

The value of the attribute, or an empty string if no attribute with the given localName and namespaceURI is found.

at line 1878
void setAttributeNS(string $namespace, string $qualifiedName, string $value)

Adds new attribute

Parameters

string $namespace

The namespace URI.

string $qualifiedName

The qualified name of the attribute, as prefix:tagname.

string $value

The value of the attribute.

Return Value

void

at line 1896
void removeAttributeNS(string $namespace, string $localName)

Removes attribute

Parameters

string $namespace

The namespace URI.

string $localName

The local name.

Return Value

void

true on success or false on failure.

at line 1913
DOMAttr getAttributeNodeNS(string $namespace, string $localName)

Returns attribute node

Parameters

string $namespace

The namespace URI.

string $localName

The local name.

Return Value

DOMAttr

The attribute node.

at line 1924
DOMAttr setAttributeNodeNS(DOMAttr $attr)

Adds new attribute node to element

Parameters

DOMAttr $attr

Return Value

DOMAttr

the old node if the attribute has been replaced.

at line 1940
DOMNodeList getElementsByTagNameNS(string $namespace, string $localName)

Get elements by namespaceURI and localName

Parameters

string $namespace

The namespace URI.

string $localName

The local name. Use * to return all elements within the element tree.

Return Value

DOMNodeList

This function returns a new instance of the class DOMNodeList of all matched elements in the order in which they are encountered in a preorder traversal of this element tree.

at line 1954
bool hasAttribute(string $qualifiedName)

Checks to see if attribute exists

Parameters

string $qualifiedName

The attribute name.

Return Value

bool

true on success or false on failure.

at line 1968
bool hasAttributeNS(string $namespace, string $localName)

Checks to see if attribute exists

Parameters

string $namespace

The namespace URI.

string $localName

The local name.

Return Value

bool

true on success or false on failure.

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

Declares the attribute specified by name to be of type ID

Parameters

string $qualifiedName

The name of the attribute.

bool $isId

Set it to true if you want name to be of type ID, false otherwise.

Return Value

void

at line 2007
void setIdAttributeNS(string $namespace, string $qualifiedName, bool $isId)

Declares the attribute specified by local name and namespace URI to be of type ID

Parameters

string $namespace

The namespace URI of the attribute.

string $qualifiedName

The local name of the attribute, as prefix:tagname.

bool $isId

Set it to true if you want name to be of type ID, false otherwise.

Return Value

void

at line 2026
void setIdAttributeNode(DOMAttr $attr, bool $isId)

Declares the attribute specified by node to be of type ID

Parameters

DOMAttr $attr

The attribute node.

bool $isId

Set it to true if you want name to be of type ID, false otherwise.

Return Value

void

at line 2032
void remove()

Acts as a simpler version of {DOMNode

Return Value

void

at line 2037
void before(DOMNode|string|null ...$nodes)

Add passed node(s) before the current node

Parameters

DOMNode|string|null ...$nodes

Return Value

void

at line 2042
void after(DOMNode|string|null ...$nodes)

Add passed node(s) after the current node

Parameters

DOMNode|string|null ...$nodes

Return Value

void

at line 2047
void replaceWith(DOMNode|string|null ...$nodes)

Replace current node with new node(s), a combination of {DOMChildNode::remove()} + {DOMChildNode::append()}.

Parameters

DOMNode|string|null ...$nodes

Return Value

void

at line 2052
void append(DOMNode|string|null ...$nodes)

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

Parameters

DOMNode|string|null ...$nodes

Return Value

void

at line 2057
void prepend(DOMNode|string|null ...$nodes)

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

Parameters

DOMNode|string|null ...$nodes

Return Value

void

at line 2063
void replaceChildren(...$nodes)

Since: 8.3 {@inheritDoc}

No description

Parameters

...$nodes

Return Value

void

at line 2073
__construct(string $qualifiedName, string|null $value = null, string $namespace = '')

Creates a new DOMElement object

Parameters

string $qualifiedName

The tag name of the element. When also passing in namespaceURI, the element name may take a prefix to be associated with the URI.
string|null $value

[optional] The value of the element.
string $namespace

[optional] A namespace URI to create the element within a specific namespace.

Exceptions

DOMException

at line 2082
array getAttributeNames()

Since: 8.3

No description

Return Value

array

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

Since: 8.3

No description

Parameters

string $qualifiedName
bool|null $force

Return Value

bool

at line 2092
DOMElement|null insertAdjacentElement(string $where, DOMElement $element)

Since: 8.3

No description

Parameters

string $where
DOMElement $element

Return Value

DOMElement|null

at line 2097
void insertAdjacentText(string $where, string $data)

Since: 8.3

No description

Parameters

string $where
string $data

Return Value

void