DOMEntityReference

class DOMEntityReference extends DOMNode (View source)

Extends DOMNode.

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 from  DOMNode
DOMNode> $childNodes from  DOMNode
DOMNode|null $firstChild from  DOMNode
DOMNode|null $lastChild from  DOMNode
DOMNode|null $previousSibling from  DOMNode
DOMNode|null $nextSibling from  DOMNode
DOMAttr>|null $attributes from  DOMNode
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

Methods

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

Adds a new child before a reference node

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

Replaces a child

from  DOMNode
TNode|false
removeChild(DOMNode $child)

Removes child from list of children

from  DOMNode
TNode|false
appendChild(DOMNode $node)

Adds new child at the end of the children

from  DOMNode
bool
hasChildNodes()

Checks if node has children

from  DOMNode
DOMNode|false
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)

Compares the position of two nodes

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(DOMNode|null $otherNode)

Checks that both nodes are equal

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)

Checks if node contains other node

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

Get root node

from  DOMNode
array
__sleep()

Forbids serialization unless serialization methods are implemented in a subclass

from  DOMNode
void
__wakeup()

Forbids unserialization unless unserialization methods are implemented in a subclass

from  DOMNode
__construct(string $name)

Creates a new DOMEntityReference object

Details

in DOMNode at line 183
TNode|false 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

TNode|false

The inserted node.

Exceptions

DOMException

in DOMNode at line 210
TNode|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

TNode|false

The old node or false if an error occur.

Exceptions

DOMException

in DOMNode at line 225
TNode|false removeChild(DOMNode $child)

Removes child from list of children

Parameters

DOMNode $child

The removed child.

Return Value

TNode|false

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

Exceptions

DOMException

in DOMNode at line 243
TNode|false appendChild(DOMNode $node)

Adds new child at the end of the children

Parameters

DOMNode $node

The appended child.

Return Value

TNode|false

The node added.

Exceptions

DOMException

in DOMNode at line 250
bool hasChildNodes()

Checks if node has children

Return Value

bool

true on success or false on failure.

in DOMNode at line 262
DOMNode|false 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|false

The cloned node.

in DOMNode at line 272
void normalize()

Normalizes the node

Return Value

void

No value is returned.

in DOMNode at line 288
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 299
bool hasAttributes()

Checks if node has attributes

Return Value

bool

true on success or false on failure.

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

Compares the position of two nodes

Compares the position of the other node relative to this node.

Parameters

DOMNode $other

Return Value

int

A bitmask of the DOMNode::DOCUMENTPOSITION* constants.

in DOMNode at line 321
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 332
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 344
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 355
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 367
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 376
bool isEqualNode(DOMNode|null $otherNode)

Checks that both nodes are equal

Parameters

DOMNode|null $otherNode

The node.

Return Value

bool

Returns true if both nodes are equal, false otherwise.

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

No description

Parameters

$feature
$version

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

No description

Parameters

$key
$data
$handler

in DOMNode at line 392
getUserData($key)

No description

Parameters

$key

in DOMNode at line 399
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 407
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 419
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 437
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

Path to write the output to.
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 451
bool contains(DOMNode|DOMNameSpaceNode|null $other)

Since: 8.3

Checks if node contains other node

Parameters

DOMNode|DOMNameSpaceNode|null $other

Return Value

bool

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

Since: 8.3

Get root node

Parameters

array|null $options

Return Value

DOMNode

in DOMNode at line 466
array __sleep()

Since: 8.1

Forbids serialization unless serialization methods are implemented in a subclass

Return Value

array

Exceptions

Error

in DOMNode at line 474
void __wakeup()

Since: 8.1

Forbids unserialization unless unserialization methods are implemented in a subclass

Return Value

void

Exceptions

Error

at line 2603
__construct(string $name)

Creates a new DOMEntityReference object

Parameters

string $name

The name of the entity reference.