AbstractSoftReferenceParser implements SoftReferenceParserInterface
AbstractYes
A generic parser class useful if tokenID prefixes are needed.
Table of Contents
Interfaces
- SoftReferenceParserInterface
- Soft Reference parsing interface
Properties
- $parameters : array<string|int, mixed>
- $parserKey : string
- $tokenID_basePrefix : string
Methods
- getParserKey() : string
- Returns the parser key, which was previously set by "setParserKey"
- makeTokenID() : string
- Make Token ID for input index.
- setParserKey() : void
- The two properties parserKey and parameters may be set to generate a unique token ID from them.
- setTokenIdBasePrefix() : void
Properties
$parameters
protected
array<string|int, mixed>
$parameters
= []
$parserKey
protected
string
$parserKey
= ''
$tokenID_basePrefix
protected
string
$tokenID_basePrefix
= ''
Methods
getParserKey()
Returns the parser key, which was previously set by "setParserKey"
public
getParserKey() : string
Return values
stringmakeTokenID()
Make Token ID for input index.
public
makeTokenID([string $index = '' ]) : string
Parameters
- $index : string = ''
-
Suffix value.
Return values
string —Token ID
setParserKey()
The two properties parserKey and parameters may be set to generate a unique token ID from them.
public
setParserKey(string $parserKey, array<string|int, mixed> $parameters) : void
Parameters
- $parserKey : string
-
The softref parser key.
- $parameters : array<string|int, mixed>
-
Parameters of the softlink parser. Basically this is the content inside optional []-brackets after the softref keys. Parameters are exploded by ";
setTokenIdBasePrefix()
protected
setTokenIdBasePrefix(string $table, string $uid, string $field, string $structurePath) : void
Parameters
- $table : string
- $uid : string
- $field : string
- $structurePath : string