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

classDOMCharacterDataextendsDOMNodeimplementsDOMChildNode {

/* Inherited constants */

publicconstintDOMNode::DOCUMENT_POSITION_DISCONNECTED = 0x1;

publicconstintDOMNode::DOCUMENT_POSITION_PRECEDING = 0x2;

publicconstintDOMNode::DOCUMENT_POSITION_FOLLOWING = 0x4;

publicconstintDOMNode::DOCUMENT_POSITION_CONTAINS = 0x8;

publicconstintDOMNode::DOCUMENT_POSITION_CONTAINED_BY = 0x10;

publicconstintDOMNode::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;

/* Properties */

publicstring$data;

publicreadonlyint$length;

publicreadonly?DOMElement$previousElementSibling;

publicreadonly?DOMElement$nextElementSibling;

/* Inherited properties */

publicreadonlystring$nodeName;

public?string$nodeValue;

publicreadonlyint$nodeType;

publicreadonly?DOMNode$parentNode;

publicreadonly?DOMElement$parentElement;

publicreadonlyDOMNodeList$childNodes;

publicreadonly?DOMNode$firstChild;

publicreadonly?DOMNode$lastChild;

publicreadonly?DOMNode$previousSibling;

publicreadonly?DOMNode$nextSibling;

publicreadonly?DOMNamedNodeMap$attributes;

publicreadonlybool$isConnected;

publicreadonly?DOMDocument$ownerDocument;

publicreadonly?string$namespaceURI;

publicstring$prefix;

publicreadonly?string$localName;

publicreadonly?string$baseURI;

publicstring$textContent;

/* Methods */

publicafter(DOMNode|string...$nodes):void

publicappendData(string$data):true

publicbefore(DOMNode|string...$nodes):void

publicdeleteData(int$offset,int$count):bool

publicinsertData(int$offset,string$data):bool

publicremove():void

publicreplaceData(int$offset,int$count,string$data):bool

publicreplaceWith(DOMNode|string...$nodes):void

publicsubstringData(int$offset,int$count):string|false

/* Inherited methods */

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

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

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

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

publicDOMNode::compareDocumentPosition(DOMNode$other):int

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

publicDOMNode::getLineNo():int

publicDOMNode::getNodePath():?string

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

publicDOMNode::hasAttributes():bool

publicDOMNode::hasChildNodes():bool

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

publicDOMNode::isDefaultNamespace(string$namespace):bool

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

publicDOMNode::isSameNode(DOMNode$otherNode):bool

publicDOMNode::isSupported(string$feature,string$version):bool

publicDOMNode::lookupNamespaceURI(?string$prefix):?string

publicDOMNode::lookupPrefix(string$namespace):?string

publicDOMNode::normalize():void

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

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

publicDOMNode::__sleep():array

publicDOMNode::__wakeup():void

}

Properties

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

Changelog

Version	Description
8.0.0	The`nextElementSibling` and`previousElementSibling` properties have been added.
8.0.0	DOMCharacterData implementsDOMChildNode 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 Notes1 note

down

jesdisciple dot FOO at gmail dot BAR dot com ¶

15 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