TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
LinkHandlerInterface Interface Reference
Inheritance diagram for LinkHandlerInterface:
FileLinkHandler MailLinkHandler PageLinkHandler UrlLinkHandler AddImageHandler EditImageHandler FolderLinkHandler

Public Member Functions

 getLinkAttributes ()
 
 modifyLinkAttributes (array $fieldDefinitions)
 
 initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
 
 canHandleLink (array $linkParts)
 
 formatCurrentUrl ()
 
 render (ServerRequestInterface $request)
 
 isUpdateSupported ()
 
 getBodyTagAttributes ()
 

Detailed Description

Interface for link handlers displayed in the LinkBrowser

Definition at line 23 of file LinkHandlerInterface.php.

Member Function Documentation

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$linkPartsLink parts as returned from TypoLinkCodecService
Returns
bool

Implemented in AddImageHandler, FileLinkHandler, EditImageHandler, MailLinkHandler, UrlLinkHandler, and PageLinkHandler.

formatCurrentUrl ( )

Format the current link for HTML output

Returns
string

Implemented in AddImageHandler, PageLinkHandler, FileLinkHandler, EditImageHandler, MailLinkHandler, and UrlLinkHandler.

getBodyTagAttributes ( )
Returns
string[] Array of body-tag attributes

Implemented in AddImageHandler, PageLinkHandler, FileLinkHandler, EditImageHandler, MailLinkHandler, UrlLinkHandler, and FolderLinkHandler.

getLinkAttributes ( )
Returns
array

Implemented in AddImageHandler, and EditImageHandler.

initialize ( AbstractLinkBrowserController  $linkBrowser,
  $identifier,
array  $configuration 
)

Initialize the handler

Parameters
AbstractLinkBrowserController$linkBrowser
string$identifier
array$configurationPage TSconfig
Returns
void

Implemented in AddImageHandler, and EditImageHandler.

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

Implemented in AddImageHandler, and EditImageHandler.

modifyLinkAttributes ( array  $fieldDefinitions)
Parameters
string[]$fieldDefinitions Array of link attribute field definitions
Returns
string[]

Implemented in AddImageHandler, PageLinkHandler, and EditImageHandler.

render ( ServerRequestInterface  $request)

Render the link handler

Parameters
ServerRequestInterface$request
Returns
string

Implemented in EditImageHandler, MailLinkHandler, and UrlLinkHandler.