Represents a source offset range. More...
Inheritance diagram for Wikimedia\Parsoid\Tokens\SourceRange:
Collaboration diagram for Wikimedia\Parsoid\Tokens\SourceRange:
Public Member Functions | |
| __construct (?int $start, ?int $end) | |
| Create a new source offset range. | |
| expandTsrK () | |
| Return a KVSourceRange where this SourceRange is the key, and the value has zero length. | |
| expandTsrV () | |
| Return a KVSourceRange where this SourceRange is the value, and the key has zero length. | |
| join (SourceRange $value) | |
| Return a KVSourceRange by using this SourceRange for the key and the given SourceRange parameter for the value. | |
| substr (string $str) | |
| Return the substring of the given string corresponding to this range. | |
| offset (int $amount) | |
| Return a new source range shifted by $amount. | |
| length () | |
| Return the length of this source range. | |
| jsonSerialize () | |
Static Public Member Functions | |
| static | fromArray (array $sr) |
| Create a new source offset range from an array of integers (such as created during JSON serialization). | |
Public Attributes | |
| $start | |
| $end | |
Detailed Description
Represents a source offset range.
Constructor & Destructor Documentation
◆ __construct()
| Wikimedia\Parsoid\Tokens\SourceRange::__construct | ( | ?int | $start, |
| ?int | $end ) |
Create a new source offset range.
- Parameters
-
?int $start The starting index (UTF-8 byte count, inclusive) ?int $end The ending index (UTF-8 byte count, exclusive)
Member Function Documentation
◆ expandTsrK()
| Wikimedia\Parsoid\Tokens\SourceRange::expandTsrK | ( | ) |
Return a KVSourceRange where this SourceRange is the key, and the value has zero length.
- Returns
- KVSourceRange
◆ expandTsrV()
| Wikimedia\Parsoid\Tokens\SourceRange::expandTsrV | ( | ) |
Return a KVSourceRange where this SourceRange is the value, and the key has zero length.
- Returns
- KVSourceRange
◆ fromArray()
|
static |
Create a new source offset range from an array of integers (such as created during JSON serialization).
- Parameters
-
int[] $sr
- Returns
- SourceRange
Reimplemented in Wikimedia\Parsoid\Core\DomSourceRange.
◆ join()
| Wikimedia\Parsoid\Tokens\SourceRange::join | ( | SourceRange | $value | ) |
Return a KVSourceRange by using this SourceRange for the key and the given SourceRange parameter for the value.
- Parameters
-
SourceRange $value
- Returns
- KVSourceRange
◆ jsonSerialize()
| Wikimedia\Parsoid\Tokens\SourceRange::jsonSerialize | ( | ) |
Reimplemented in Wikimedia\Parsoid\Core\DomSourceRange.
◆ length()
| Wikimedia\Parsoid\Tokens\SourceRange::length | ( | ) |
Return the length of this source range.
- Returns
- int
◆ offset()
| Wikimedia\Parsoid\Tokens\SourceRange::offset | ( | int | $amount | ) |
Return a new source range shifted by $amount.
- Parameters
-
int $amount The amount to shift by
- Returns
- SourceRange
Reimplemented in Wikimedia\Parsoid\Core\DomSourceRange.
◆ substr()
| Wikimedia\Parsoid\Tokens\SourceRange::substr | ( | string | $str | ) |
Return the substring of the given string corresponding to this range.
- Parameters
-
string $str The source text string
- Returns
- string
The documentation for this class was generated from the following file:
- src/Tokens/SourceRange.php
