TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult Class Reference

Public Member Functions
	hasMatched ()
	hasContent ()
	getContent ()
	getMatchedElements ()

Static Public Member Functions
static	create (string $content, array $elements)
static	createWithoutMatches ()

Private Attributes
string	$content = ''
array	$elements = []
bool	$hasMatched = false

Detailed Description

The result object has two properties: "content" and matched elements.

content: Is a string containing the input content but possibly with tokens inside. Tokens are strings like {softref:[tokenID]}, which is a placeholder for a value extracted by a softref parser. For each token there MUST be an entry in the "elements" key, which has a "subst" key defining the tokenID and the tokenValue. See below.

matched elements: is an array where the keys are insignificant, but the values are arrays with these keys: "matchString" => // The value of the match. This is only for informational purposes to show what was found. "error" => // An error message can be set here, like "file not found" etc. "subst" => [ // If this array is found there MUST be a token in the output content as well! "tokenID" => // The tokenID string corresponding to the token in output content, {softref:[tokenID]}. This is typically an md5 hash of a string defining uniquely the position of the element. "tokenValue" => // The value that the token substitutes in the text. Basically, if this value is inserted instead of the token the content should match what was inputted originally. "type" => // file / db / string = the type of substitution. "file" means it is a relative file [automatically mapped], "db" means a database record reference [automatically mapped], "string" means it is manually modified string content (eg. an email address) "relFileName" => // (for "file" type): Relative filename. May not necessarily exist. This could be noticed in the error key. "recordRef" => // (for "db" type) : Reference to DB record on the form [table]:[uid]. May not necessarily exist. "title" => // Title of element (for backend information) "description" => // Description of element (for backend information) ]

Definition at line 42 of file SoftReferenceParserResult.php.

Member Function Documentation

create()

static TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::create ( string  $content, array  $elements  )

static

Definition at line 48 of file SoftReferenceParserResult.php.

References TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\$content, TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\$elements, and TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\createWithoutMatches().

Referenced by TYPO3\CMS\Form\SoftReference\FormPersistenceIdentifierSoftReferenceParser\createResultForExtensionReference(), TYPO3\CMS\Core\DataHandling\SoftReference\EmailSoftReferenceParser\parse(), TYPO3\CMS\Core\DataHandling\SoftReference\SubstituteSoftReferenceParser\parse(), TYPO3\CMS\Core\DataHandling\SoftReference\UrlSoftReferenceParser\parse(), TYPO3\CMS\Core\DataHandling\SoftReference\ExtensionPathSoftReferenceParser\parse(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkTagSoftReferenceParser\parse(), TYPO3\CMS\Form\SoftReference\FormPersistenceIdentifierSoftReferenceParser\parse(), and TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\parse().

createWithoutMatches()

static TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::createWithoutMatches ( )

static

Definition at line 62 of file SoftReferenceParserResult.php.

Referenced by TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\create(), and TYPO3\CMS\Form\SoftReference\FormPersistenceIdentifierSoftReferenceParser\parse().

getContent()

TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::getContent

(

)

Definition at line 77 of file SoftReferenceParserResult.php.

References TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\$content.

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\analyzeTypoLinks().

getMatchedElements()

TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::getMatchedElements

(

)

Definition at line 82 of file SoftReferenceParserResult.php.

References TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\$elements.

Referenced by TYPO3\CMS\Linkvalidator\LinkAnalyzer\analyzeLinks(), and TYPO3\CMS\Linkvalidator\LinkAnalyzer\analyzeTypoLinks().

hasContent()

TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::hasContent

(

)

Definition at line 72 of file SoftReferenceParserResult.php.

hasMatched()

TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::hasMatched

(

)

Definition at line 67 of file SoftReferenceParserResult.php.

References TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\$hasMatched.

Member Data Documentation

$content

string TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::$content = ''

private

Definition at line 44 of file SoftReferenceParserResult.php.

Referenced by TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\create(), and TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\getContent().

$elements

array TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::$elements = []

private

Definition at line 45 of file SoftReferenceParserResult.php.

Referenced by TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\create(), and TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\getMatchedElements().

$hasMatched

bool TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult::$hasMatched = false

private

Definition at line 46 of file SoftReferenceParserResult.php.

Referenced by TYPO3\CMS\Core\DataHandling\SoftReference\SoftReferenceParserResult\hasMatched().