TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface:

Public Member Functions
	getIdentifier ()
bool	checkLink (string $url, array $softRefEntry, LinkAnalyzer $reference)
	setAdditionalConfig (array $config)
string	fetchType (array $value, string $type, string $key)
array	getErrorParams ()
string	getBrokenUrl (array $row)
string	getErrorMessage (array $errorParams)

Detailed Description

This class provides interface implementation.

Definition at line 25 of file LinktypeInterface.php.

Member Function Documentation

checkLink()

bool TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::checkLink	(	string	$url,
		array	$softRefEntry,
		LinkAnalyzer	$reference
	)

Checks a given link for validity

Parameters

string	$url	‪Url to check
array	$softRefEntry	‪The soft reference entry which builds the context of that url
\TYPO3\CMS\Linkvalidator\LinkAnalyzer	$reference	‪Parent instance

Returns

‪bool TRUE on success or FALSE on error

Implemented in TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\FileLinktype, and TYPO3\CMS\Linkvalidator\Linktype\ExternalLinktype.

fetchType()

string TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::fetchType	(	array	$value,
		string	$type,
		string	$key
	)

Base type fetching method, based on the type that softRefParserObj returns.

Parameters

array	$value	‪Reference properties
string	$type	‪Current type
string	$key	‪Validator hook name

Returns

‪string Fetched type

Implemented in TYPO3\CMS\Linkvalidator\Linktype\ExternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype, and TYPO3\CMS\Linkvalidator\Linktype\FileLinktype.

getBrokenUrl()

string TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::getBrokenUrl

(

array

$row

)

Construct a valid Url for browser output

Parameters

array

$row

‪Broken link record

Returns

‪string Parsed broken url

Implemented in TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype, and TYPO3\CMS\Linkvalidator\Linktype\FileLinktype.

getErrorMessage()

string TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::getErrorMessage

(

array

$errorParams

)

Generate the localized error message from the error params saved from the parsing

Parameters

array

$errorParams

‪All parameters needed for the rendering of the error message

Returns

‪string Validation error message

Implemented in TYPO3\CMS\Linkvalidator\Linktype\ExternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype, and TYPO3\CMS\Linkvalidator\Linktype\FileLinktype.

getErrorParams()

array TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::getErrorParams

(

)

Get the value of the private property errorParams.

Returns

‪array All parameters needed for the rendering of the error message

Implemented in TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype.

getIdentifier()

TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::getIdentifier

(

)

Returns the unique identifier of the linktype

Implemented in TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype.

setAdditionalConfig()

TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::setAdditionalConfig

(

array

$config

)

Function to override config of Linktype. Should be used only if necessary. Add additional configuration to TSconfig.

Implemented in TYPO3\CMS\Linkvalidator\Linktype\ExternalLinktype, and TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype.