Dom\CharacterData::substringData

Extracts a range of data from the character data

Description

public string Dom\CharacterData::substringData(int $offset, int $count)

Returns the specified substring.

Parameters

offset

Start offset of substring to extract.

count

The number of characters to extract.

Return Values

The specified substring. If the sum of offset and count exceeds the length, then all UTF-8 codepoints to the end of the data are returned.

Errors/Exceptions

DOM_INDEX_SIZE_ERR

Raised if offset is negative or greater than the number of UTF-8 codepoints in data, or if count is negative.

See Also

  • Dom\CharacterData::appendData
  • Dom\CharacterData::deleteData
  • Dom\CharacterData::insertData
  • Dom\CharacterData::replaceData