TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface:

Public Member Functions
array	getLinkAttributes ()
string[]	modifyLinkAttributes (array $fieldDefinitions)
	initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
bool	canHandleLink (array $linkParts)
string	formatCurrentUrl ()
string	render (ServerRequestInterface $request)
bool	isUpdateSupported ()
string[]	getBodyTagAttributes ()

Detailed Description

Interface for link handlers displayed in the LinkBrowser

Definition at line 24 of file LinkHandlerInterface.php.

Member Function Documentation

canHandleLink()

bool TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::canHandleLink

(

array

$linkParts

)

Checks if this is the handler for the given link

The handler may store this information locally for later usage.

Parameters

array

$linkParts

‪Link parts as returned from TypoLinkCodecService

Returns

‪bool

Implemented in TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\TelephoneLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\MailLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\UrlLinkHandler, and TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler.

formatCurrentUrl()

string TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::formatCurrentUrl

(

)

Format the current link for HTML output

Returns

‪string

Implemented in TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\TelephoneLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\MailLinkHandler, and TYPO3\CMS\Recordlist\LinkHandler\UrlLinkHandler.

getBodyTagAttributes()

string [] TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::getBodyTagAttributes

(

)

Returns

‪string[] Array of body-tag attributes

Implemented in TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\TelephoneLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\MailLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\UrlLinkHandler, and TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler.

getLinkAttributes()

array TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::getLinkAttributes

(

)

Returns

‪array

initialize()

TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::initialize	(	AbstractLinkBrowserController	$linkBrowser,
			$identifier,
		array	$configuration
	)

Initialize the handler

Parameters

AbstractLinkBrowserController	$linkBrowser
string	$identifier
array	$configuration	‪Page TSconfig

Implemented in TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler.

isUpdateSupported()

bool TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::isUpdateSupported

(

)

Return TRUE if the handler supports to update a link.

This is useful for file or page links, when only attributes are changed.

Returns

‪bool

modifyLinkAttributes()

string [] TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::modifyLinkAttributes

(

array

$fieldDefinitions

)

Parameters

string[]

$fieldDefinitions

‪Array of link attribute field definitions

Returns

‪string[]

Implemented in TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler.

render()

string TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface::render

(

ServerRequestInterface

$request

)

Render the link handler

Parameters

ServerRequestInterface

$request

Returns

‪string

Implemented in TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\TelephoneLinkHandler, TYPO3\CMS\Recordlist\LinkHandler\MailLinkHandler, and TYPO3\CMS\Recordlist\LinkHandler\UrlLinkHandler.