TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler Class Reference

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

Public Member Functions
bool	canHandleLink (array $linkParts)
string	formatCurrentUrl ()
string	render (ServerRequestInterface $request)
string[]	getBodyTagAttributes ()
string[]	getUrlParameters (array $values)
bool	isCurrentlySelectedItem (array $values)
string	getScriptUrl ()
string[]	modifyLinkAttributes (array $fieldDefinitions)
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
	__construct ()
	initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
array	getLinkAttributes ()
bool	isUpdateSupported ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface
array	getLinkAttributes ()
	initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
bool	isUpdateSupported ()

Protected Member Functions
	getRecordsOnExpandedPage ($pageId)
string	getTemporaryTreeMountCancelNotice ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
	setTemporaryDbMounts ()
BackendUserAuthentication	getBackendUser ()
LanguageService	getLanguageService ()

Protected Attributes
int	$expandPage = 0
array	$linkParts = array( )
‪Protected Attributes inherited from ‪TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler
string[]	$linkAttributes = array( 'target', 'title', 'class', 'params', 'rel' )
bool	$updateSupported = true
AbstractLinkBrowserController	$linkBrowser
IconFactory	$iconFactory
TYPO3 CMS Fluid View StandaloneView	$view

Detailed Description

Link handler for page (and content) links

This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.

Definition at line 35 of file PageLinkHandler.php.

Member Function Documentation

canHandleLink()

bool TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::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

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 56 of file PageLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\$linkParts, and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL().

formatCurrentUrl()

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

(

)

Format the current link for HTML output

Returns

‪string

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 108 of file PageLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL().

getBodyTagAttributes()

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

(

)

Returns

‪string[] Array of body-tag attributes

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 230 of file PageLinkHandler.php.

References TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_PAGE.

getRecordsOnExpandedPage()

TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::getRecordsOnExpandedPage (   $pageId )

protected

This adds all content elements on a page to the view and lets you create a link to the element.

Parameters

int

$pageId

‪Page uid to expand

Definition at line 155 of file PageLinkHandler.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_PAGE.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\render().

getScriptUrl()

string TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::getScriptUrl

(

)

Returns the URL of the current script

Returns

‪string

Implements TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface.

Definition at line 272 of file PageLinkHandler.php.

getTemporaryTreeMountCancelNotice()

string TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::getTemporaryTreeMountCancelNotice ( )

protected

Check if a temporary tree mount is set and return a cancel button link

Returns

‪string the link to cancel the temporary tree mount

Definition at line 219 of file PageLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser().

Referenced by TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\render().

getUrlParameters()

string [] TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::getUrlParameters

(

array

$values

)

Parameters

array

$values

‪Array of values to include into the parameters or which might influence the parameters

Returns

‪string[] Array of parameters which have to be added to URLs

Implements TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface.

Definition at line 249 of file PageLinkHandler.php.

isCurrentlySelectedItem()

bool TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::isCurrentlySelectedItem

(

array

$values

)

Parameters

array

$values

‪Values to be checked

Returns

‪bool Returns TRUE if the given values match the currently selected item

Implements TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface.

Definition at line 262 of file PageLinkHandler.php.

modifyLinkAttributes()

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

(

array

$fieldDefinitions

)

Parameters

string[]

$fieldDefinitions

‪Array of link attribute field definitions

Returns

‪string[]

Reimplemented from TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler.

Definition at line 281 of file PageLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getLanguageService().

render()

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

(

ServerRequestInterface

$request

)

Render the link handler

Parameters

ServerRequestInterface

$request

Returns

‪string

Implements TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface.

Definition at line 128 of file PageLinkHandler.php.

References TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\getRecordsOnExpandedPage(), TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\getTemporaryTreeMountCancelNotice(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), and TYPO3\CMS\Recordlist\LinkHandler\AbstractLinkHandler\setTemporaryDbMounts().

Member Data Documentation

$expandPage

int TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::$expandPage = 0

protected

Definition at line 39 of file PageLinkHandler.php.

$linkParts

array TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler::$linkParts = array( )

protected

Parts of the current link

Definition at line 45 of file PageLinkHandler.php.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\canHandleLink().