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

findRef()  : mixed
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

findRef()

public findRef(string $table, string $field, int $uid, string $content, string $spKey, array<string|int, mixed> $spParams[, string $structurePath = '' ]) : mixed
Parameters
$table : string
$field : string
$uid : int
$content : string
$spKey : string
$spParams : array<string|int, mixed>
$structurePath : string = ''
Internal

will be removed in favor of ->parse() in TYPO3 v12.0.

getParserKey()

Returns the parser key, which was previously set by "setParserKey"

public getParserKey() : string
Return values
string

makeTokenID()

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

        
On this page

Search results