TYPO3\CMS\Linkvalidator\Linktype\LinkHandler Class Reference

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

Public Member Functions
	checkLink ($url, $softRefEntry, $reference)
	fetchType ($value, $type, $key)
	getErrorMessage ($errorParams)
Public Member Functions inherited from TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype
	fetchType ($value, $type, $key)
	getErrorParams ()
	getBrokenUrl ($row)

Public Attributes
const	DELETED = 'deleted'
const	DISABLED = 'disabled'

Protected Member Functions
	getTranslatedErrorMessage ($translationKey, $uid, $title=null)
	getRecordRow ($tableName, $uid, $filter='')
Protected Member Functions inherited from TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype
	setErrorParams ($value)
	getLanguageService ()
	getDatabaseConnection ()

Additional Inherited Members
Protected Attributes inherited from TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype
	$errorParams = []

Detailed Description

This class provides Check Link Handler plugin implementation

Definition at line 23 of file LinkHandler.php.

Member Function Documentation

checkLink()

TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::checkLink	(		$url,
			$softRefEntry,
			$reference
	)

Checks a given URL 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

Implements TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface.

Definition at line 43 of file LinkHandler.php.

References TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\$errorParams, TYPO3\CMS\Linkvalidator\Linktype\LinkHandler\getRecordRow(), and TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\setErrorParams().

fetchType()

TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::fetchType	(		$value,
			$type,
			$key
	)

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

Implements TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface.

Definition at line 108 of file LinkHandler.php.

References TYPO3\CMS\Core\Utility\StringUtility\beginsWith().

getErrorMessage()

TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::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

Implements TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface.

Definition at line 122 of file LinkHandler.php.

References TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\$errorParams, $GLOBALS, TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\getLanguageService(), and TYPO3\CMS\Linkvalidator\Linktype\LinkHandler\getTranslatedErrorMessage().

getRecordRow()

TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::getRecordRow (   $tableName,   $uid,   $filter = ''  )

protected

Fetches the record with the given UID from the given table.

The filter option accepts two values:

"disabled" will filter out disabled and deleted records. "deleted" filters out deleted records but will return disabled records. If nothing is specified all records will be returned (including deleted).

Parameters

string	$tableName	The name of the table from which the record should be fetched.
int	$uid	The UID of the record that should be fetched.
string	$filter	A filter setting, can be empty or "disabled" or "deleted".

Returns

array|NULL The result row as associative array or NULL if nothing is found.

Definition at line 176 of file LinkHandler.php.

References $uid, TYPO3\CMS\Backend\Utility\BackendUtility\BEenableFields(), TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), and TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\getDatabaseConnection().

Referenced by TYPO3\CMS\Linkvalidator\Linktype\LinkHandler\checkLink().

getTranslatedErrorMessage()

TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::getTranslatedErrorMessage (   $translationKey,   $uid,   $title = null  )

protected

Fetches the translation with the given key and replaces the ###uid### and ###title### markers

Parameters

string	$translationKey
int	$uid
string	$title

Returns

string

Definition at line 152 of file LinkHandler.php.

References $uid, and TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\getLanguageService().

Referenced by TYPO3\CMS\Linkvalidator\Linktype\LinkHandler\getErrorMessage().

Member Data Documentation

DELETED

const TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::DELETED = 'deleted'

Definition at line 28 of file LinkHandler.php.

DISABLED

const TYPO3\CMS\Linkvalidator\Linktype\LinkHandler::DISABLED = 'disabled'

Definition at line 33 of file LinkHandler.php.