TYPO3\CMS\Backend\LinkHandler\PageLinkHandler Class Reference

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

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

Protected Member Functions
	getRecordsOnExpandedPage ($pageId)
	isPageLinkable (array $page)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\LinkHandler\AbstractLinkHandler
	getBackendUser ()
	getLanguageService ()

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

Detailed Description

Link to a page record.

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

Definition at line 39 of file PageLinkHandler.php.

Member Function Documentation

canHandleLink()

bool TYPO3\CMS\Backend\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\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 60 of file PageLinkHandler.php.

References TYPO3\CMS\Backend\LinkHandler\PageLinkHandler\$linkParts.

formatCurrentUrl()

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

(

)

Format the current link for HTML output

Returns

‪string

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 85 of file PageLinkHandler.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Backend\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Backend\LinkHandler\AbstractLinkHandler\getLanguageService(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

getBodyTagAttributes()

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

(

)

Returns

‪string[] Array of body-tag attributes

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 197 of file PageLinkHandler.php.

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

getRecordsOnExpandedPage()

TYPO3\CMS\Backend\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 129 of file PageLinkHandler.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Backend\LinkHandler\AbstractLinkHandler\getBackendUser(), TYPO3\CMS\Backend\LinkHandler\PageLinkHandler\isPageLinkable(), TYPO3\CMS\Core\Database\Connection\PARAM_INT, TYPO3\CMS\Core\Database\Connection\PARAM_INT_ARRAY, and TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_PAGE.

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

getUrlParameters()

string [] TYPO3\CMS\Backend\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\Backend\Tree\View\LinkParameterProviderInterface.

Definition at line 215 of file PageLinkHandler.php.

isPageLinkable()

TYPO3\CMS\Backend\LinkHandler\PageLinkHandler::isPageLinkable ( array  $page )

protected

Definition at line 249 of file PageLinkHandler.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SPACER, and TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SYSFOLDER.

Referenced by TYPO3\CMS\Backend\LinkHandler\PageLinkHandler\getRecordsOnExpandedPage().

modifyLinkAttributes()

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

(

array

$fieldDefinitions

)

Parameters

string[]

$fieldDefinitions

‪Array of link attribute field definitions

Returns

‪string[]

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

Definition at line 227 of file PageLinkHandler.php.

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

render()

TYPO3\CMS\Backend\LinkHandler\PageLinkHandler::render

(

ServerRequestInterface

$request

)

Render the link handler

Implements TYPO3\CMS\Backend\LinkHandler\LinkHandlerInterface.

Definition at line 109 of file PageLinkHandler.php.

References TYPO3\CMS\Backend\LinkHandler\AbstractLinkHandler\getBackendUser(), and TYPO3\CMS\Backend\LinkHandler\PageLinkHandler\getRecordsOnExpandedPage().

Member Data Documentation

$expandPage

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

protected

Definition at line 43 of file PageLinkHandler.php.

$linkParts

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

protected

Parts of the current link

Definition at line 49 of file PageLinkHandler.php.

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