SubstituteSoftReferenceParser extends AbstractSoftReferenceParser
A full field value targeted for manual substitution (for import /export features)
Table of Contents
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.
- parse() : SoftReferenceParserResult
- Main function through which can parse content for a specific field.
- 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
parse()
Main function through which can parse content for a specific field.
public
parse(string $table, string $field, int $uid, string $content[, string $structurePath = '' ]) : SoftReferenceParserResult
Parameters
- $table : string
-
Database table name
- $field : string
-
Field name for which processing occurs
- $uid : int
-
UID of the record
- $content : string
-
The content/value of the field
- $structurePath : string = ''
-
If running from inside a FlexForm structure, this is the path of the tag.
Return values
SoftReferenceParserResult —Result object on positive matches, see description above.
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