GroupDomain

MMO\core\helpers · 1 symbol · generated 30 Sep 2026

class

GroupDomain

A generic group domain delimited by two ALREADY-REGISTERED tokens (referenced by their id, e.g. two multi-character delimiters, or two entries from a shared token list) -- unlike aGroupDomain, which is always a single start/end character pair specific to one subclass.

class MMO\core\helpers\GroupDomain extends MMO\core\helpers\TokenDomain

Namespace: MMO\core\helpers
Extends: TokenDomain

new GroupDomain(['{{' => 1, '}}' => 2], 1, 2); // recognizes {{...}}

Index

	endID
	escape
	startID
	close($tokenizer)	Closes on the (unescaped, if applicable) end delimiter.
	debugName()
	open($tokenizer)	Opens on the (unescaped, if applicable) start delimiter.
	__construct($tokens, $startID, $endID, $escape)

Properties3

endID

protected int $endID

Type: int

escape

protected ?string $escape

Type: null | string

startID

protected int $startID

Type: int

Methods4

close($tokenizer)

Tokenizer.php:855

Closes on the (unescaped, if applicable) end delimiter.

function close(MMO\core\helpers\Tokenizer $tokenizer): ?MMO\core\helpers\Token

$tokenizer	Tokenizer
returns	null \| Token

debugName()

Tokenizer.php:844

function debugName(): string

returns

string

open($tokenizer)

Tokenizer.php:849

Opens on the (unescaped, if applicable) start delimiter.

function open(MMO\core\helpers\Tokenizer $tokenizer): ?MMO\core\helpers\Token

$tokenizer	Tokenizer
returns	null \| Token

__construct($tokens, $startID, $endID, $escape)

Tokenizer.php:835

function __construct(array $tokens, int $startID, int $endID, ?string $escape = null)

$tokens	array	must include entries for $startID and $endID (plus anything else allowed inside)
$startID	int	the id (within $tokens) of the opening delimiter
$endID	int	the id (within $tokens) of the closing delimiter
$escape = null	null \| string	the escape character, or null to disable escaping
throws		if $startID or $endID isn't actually present in $tokens

Inherited members (11)

	Properties	Declared by	Description
	`mask`	TokenDomain
	`tokens`	TokenDomain	array<id: string>

Methods	Declared by	Description
`addChar($char)`	TokenDomain	Register a single-character token (id auto-derived from the character's ord() value).
`addDomains($domains)`	TokenDomain	Register one or more nested domains (their `open` is checked on every `Tokenizer::next` call while this domain is active).
`addToken($id, $token)`	TokenDomain	Register a single multi-character token.
`addTokens($tokens)`	TokenDomain	Register several tokens/domains at once.
`getAllowedTokens()`	TokenDomain
`getMask()`	TokenDomain
`removeToken($token)`	TokenDomain
`setTokens($tokens)`	TokenDomain	Replace every registered token/domain with $tokens.
`updateMask()`	TokenDomain	Recompute `getMask` from the current token/domain list.