LinktypeInterface Interface Reference

Inheritance diagram for LinktypeInterface:

Public Member Functions
	checkLink ($url, $softRefEntry, $reference)
	fetchType ($value, $type, $key)
	getErrorParams ()
	getBrokenUrl ($row)
	getErrorMessage ($errorParams)

Detailed Description

This class provides interface implementation.

Definition at line 20 of file LinktypeInterface.php.

Member Function Documentation

checkLink	(		$url,
			$softRefEntry,
			$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

string Validation error message or success code

Implemented in InternalLinktype, FileLinktype, and LinkHandler.

fetchType	(		$value,
			$type,
			$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 ExternalLinktype, LinkHandler, AbstractLinktype, and FileLinktype.

getBrokenUrl

(

$row

)

Construct a valid Url for browser output

Parameters

array

$row

Broken link record

Returns

string Parsed broken url

Implemented in InternalLinktype, FileLinktype, and AbstractLinktype.

getErrorMessage

(

$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 InternalLinktype, ExternalLinktype, LinkHandler, and FileLinktype.

getErrorParams

(

)

Get the value of the private property errorParams.

Returns

array All parameters needed for the rendering of the error message

Implemented in AbstractLinktype.