The DOMCharacterData class

(PHP 5, PHP 7, PHP 8)

Introduction

Represents nodes with character data. No nodes directly correspond to this class, but other nodes do inherit from it.

Class synopsis

class DOMCharacterData extends DOMNode implements DOMChildNode {

/* 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 string $data;

public readonly int $length;

public readonly ?DOMElement $previousElementSibling;

public readonly ?DOMElement $nextElementSibling;

/* 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;

/* Methods */

public after(DOMNode|string ...$nodes): void

public appendData(string $data): true

public before(DOMNode|string ...$nodes): void

public deleteData(int $offset, int $count): bool

public insertData(int $offset, string $data): bool

public remove(): void

public replaceData(int $offset, int $count, string $data): bool

public replaceWith(DOMNode|string ...$nodes): void

public substringData(int $offset, int $count): string|false

/* 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

data: The contents of the node.
length: The length of the contents.
nextElementSibling: The next sibling element or null.
previousElementSibling: The previous sibling element or null.

Changelog

Version	Description
8.0.0	The `nextElementSibling` and `previousElementSibling` properties have been added.
8.0.0	DOMCharacterData implements DOMChildNode now.

DOMCharacterData::after — Adds nodes after the character data
DOMCharacterData::appendData — Append the string to the end of the character data of the node
DOMCharacterData::before — Adds nodes before the character data
DOMCharacterData::deleteData — Remove a range of characters from the character data
DOMCharacterData::insertData — Insert a string at the specified UTF-8 codepoint offset
DOMCharacterData::remove — Removes the character data node
DOMCharacterData::replaceData — Replace a substring within the character data
DOMCharacterData::replaceWith — Replaces the character data with new nodes
DOMCharacterData::substringData — Extracts a range of data from the character data

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

jesdisciple dot FOO at gmail dot BAR dot com ¶

14 years ago

In case you're looking for the CDATA class to which nodes /do/ correspond, it's called DOMCdataSection (per my PHP installation) and isn't documented on php.net.  Presumably, it doesn't add anything to this API.

See also: http://www.php.net/manual/en/domdocument.createcdatasection.php