W3cubDocs

/PHP

The DOMEntity class

Introduction

(PHP 5, PHP 7, PHP 8)

This interface represents a known entity, either parsed or unparsed, in an XML document.

Class synopsis

class DOMEntity extends DOMNode {

/* Inherited constants */

public const int DOMNode::DOCUMENT_POSITION_DISCONNECTED = 0x1;

public const int DOMNode::DOCUMENT_POSITION_PRECEDING = 0x2;

public const int DOMNode::DOCUMENT_POSITION_FOLLOWING = 0x4;

public const int DOMNode::DOCUMENT_POSITION_CONTAINS = 0x8;

public const int DOMNode::DOCUMENT_POSITION_CONTAINED_BY = 0x10;

public const int DOMNode::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;

/* Properties */

public readonly ?string $publicId;

public readonly ?string $systemId;

public readonly ?string $notationName;

public readonly ?string $actualEncoding;

public readonly ?string $encoding;

public readonly ?string $version;

/* Inherited properties */

public readonly string $nodeName;

public ?string $nodeValue;

public readonly int $nodeType;

public readonly ?DOMNode $parentNode;

public readonly ?DOMElement $parentElement;

public readonly DOMNodeList $childNodes;

public readonly ?DOMNode $firstChild;

public readonly ?DOMNode $lastChild;

public readonly ?DOMNode $previousSibling;

public readonly ?DOMNode $nextSibling;

public readonly ?DOMNamedNodeMap $attributes;

public readonly bool $isConnected;

public readonly ?DOMDocument $ownerDocument;

public readonly ?string $namespaceURI;

public string $prefix;

public readonly ?string $localName;

public readonly ?string $baseURI;

public string $textContent;

/* Inherited methods */

public DOMNode::appendChild(DOMNode $node): DOMNode|false

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

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

public DOMNode::cloneNode(bool $deep = false): DOMNode|false

public DOMNode::compareDocumentPosition(DOMNode $other): int

public DOMNode::contains(DOMNode|DOMNameSpaceNode|null $other): bool

public DOMNode::getLineNo(): int

public DOMNode::getNodePath(): ?string

public DOMNode::getRootNode(?array $options = null): DOMNode

public DOMNode::hasAttributes(): bool

public DOMNode::hasChildNodes(): bool

public DOMNode::insertBefore(DOMNode $node, ?DOMNode $child = null): DOMNode|false

public DOMNode::isDefaultNamespace(string $namespace): bool

public DOMNode::isEqualNode(?DOMNode $otherNode): bool

public DOMNode::isSameNode(DOMNode $otherNode): bool

public DOMNode::isSupported(string $feature, string $version): bool

public DOMNode::lookupNamespaceURI(?string $prefix): ?string

public DOMNode::lookupPrefix(string $namespace): ?string

public DOMNode::normalize(): void

public DOMNode::removeChild(DOMNode $child): DOMNode|false

public DOMNode::replaceChild(DOMNode $node, DOMNode $child): DOMNode|false

public DOMNode::__sleep(): array

public DOMNode::__wakeup(): void

}

Properties

publicId: The public identifier associated with the entity if specified, and null otherwise.
systemId: The system identifier associated with the entity if specified, and null otherwise. This may be an absolute URI or not.
notationName: For unparsed entities, the name of the notation for the entity. For parsed entities, this is null.
actualEncoding: Deprecated as of PHP 8.4.0. This has always been equal to null.
encoding: Deprecated as of PHP 8.4.0. This has always been equal to null.
version: Deprecated as of PHP 8.4.0. This has always been equal to null.

Changelog

Version	Description
8.4.0	`actualEncoding`, `encoding`, and `version` are formally deprecated now because they have always been equal to `null`.

© 1997–2025 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.domentity.php