Submit a Pull Request Report a Bug

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

DOMCharacterData extends DOMNode {

/* Properties */

public string $data;

public readonly int $length;

/* Inherited properties */

public readonly string $nodeName;

public string $nodeValue;

public readonly int $nodeType;

public readonly DOMNode|null $parentNode;

public readonly DOMNodeList $childNodes;

public readonly DOMNode|null $firstChild;

public readonly DOMNode|null $lastChild;

public readonly DOMNode|null $previousSibling;

public readonly DOMNode|null $nextSibling;

public readonly DOMNamedNodeMap|null $attributes;

public readonly DOMDocument|null $ownerDocument;

public readonly string|null $namespaceURI;

public string $prefix;

public readonly string $localName;

public readonly string|null $baseURI;

public string $textContent;

/* Methods */

public appendData(string $data): bool

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

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

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

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|null $xpath = null,
    array|null $nsPrefixes = null
): string|false

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

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

public DOMNode::getLineNo(): int

public DOMNode::getNodePath(): string|null

public DOMNode::hasAttributes(): bool

public DOMNode::hasChildNodes(): bool

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

public DOMNode::isDefaultNamespace(string $namespace): 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|null

public DOMNode::normalize(): void

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

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

}

Properties

data: The contents of the node.
length: The length of the contents.

DOMCharacterData::appendData — Append the string to the end of the character data of the node
DOMCharacterData::deleteData — Remove a range of characters from the node
DOMCharacterData::insertData — Insert a string at the specified 16-bit unit offset
DOMCharacterData::replaceData — Replace a substring within the DOMCharacterData node
DOMCharacterData::substringData — Extracts a range of data from the node

add a note

User Contributed Notes 1 note

down

jesdisciple dot FOO at gmail dot BAR dot com ¶

13 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