TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface Interface Reference

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

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

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! This class provides interface implementation.

Author

Michael Miousse micha.nosp@m.el.m.nosp@m.iouss.nosp@m.e@in.nosp@m.foglo.nosp@m.be.c.nosp@m.a

Definition at line 22 of file LinktypeInterface.php.

Member Function Documentation

checkLink()

TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::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 TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\FileLinktype, and TYPO3\CMS\Linkvalidator\Linktype\LinkHandler.

fetchType()

TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::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 TYPO3\CMS\Linkvalidator\Linktype\ExternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\LinkHandler, TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype, and TYPO3\CMS\Linkvalidator\Linktype\FileLinktype.

getBrokenUrl()

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

(

$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\FileLinktype, and TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype.

getErrorMessage()

TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface::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 TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\ExternalLinktype, TYPO3\CMS\Linkvalidator\Linktype\LinkHandler, and TYPO3\CMS\Linkvalidator\Linktype\FileLinktype.

getErrorParams()

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.