PageLinkHandler Class Reference

Inheritance diagram for PageLinkHandler:

Public Member Functions
	canHandleLink (array $linkParts)
	formatCurrentUrl ()
	expandPage ($expPageId)
	getBodyTagAttributes ()
	getUrlParameters (array $values)
	isCurrentlySelectedItem (array $values)
	getScriptUrl ()
	modifyLinkAttributes (array $fieldDefinitions)
Public Member Functions inherited from AbstractLinkHandler
	__construct ()
	initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
	getLinkAttributes ()
	modifyLinkAttributes (array $fieldDefinitions)
	isUpdateSupported ()
Public Member Functions inherited from LinkHandlerInterface
	getLinkAttributes ()
	initialize (AbstractLinkBrowserController $linkBrowser, $identifier, array $configuration)
	render (ServerRequestInterface $request)
	isUpdateSupported ()

Protected Member Functions
	getTemporaryTreeMountCancelNotice ()
	setTemporaryDbMounts ()
	getDatabaseConnection ()
Protected Member Functions inherited from AbstractLinkHandler
	setTemporaryDbMounts ()
	getBackendUser ()
	getLanguageService ()

Protected Attributes
	$expandPage = 0
	$linkParts = []
Protected Attributes inherited from AbstractLinkHandler
	$linkAttributes = [ 'target', 'title', 'class', 'params', 'rel' ]
	$updateSupported = true
	$linkBrowser
	$iconFactory

Detailed Description

Link handler for page (and content) links

Definition at line 31 of file PageLinkHandler.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

$linkParts

Link parts as returned from TypoLinkCodecService

Returns

bool

Implements LinkHandlerInterface.

Definition at line 54 of file PageLinkHandler.php.

References PageLinkHandler\$linkParts, MathUtility\canBeInterpretedAsInteger(), BackendUtility\getRecordsByField(), and BackendUtility\getRecordWSOL().

expandPage

(

$expPageId

)

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

Parameters

int

$expPageId

Page uid to expand

Returns

string HTML output. Returns content only if the ->expandPage value is set (pointing to a page uid to show tt_content records from ...)

Definition at line 151 of file PageLinkHandler.php.

References MathUtility\canBeInterpretedAsInteger(), BackendUtility\deleteClause(), AbstractLinkHandler\getBackendUser(), PageLinkHandler\getDatabaseConnection(), AbstractLinkHandler\getLanguageService(), BackendUtility\getRecordTitle(), BackendUtility\getRecordWSOL(), Icon\SIZE_SMALL, and BackendUtility\versioningPlaceholderClause().

Referenced by PageLinkHandler\getUrlParameters().

formatCurrentUrl

(

)

Format the current link for HTML output

Returns

string

Implements LinkHandlerInterface.

Definition at line 93 of file PageLinkHandler.php.

References $lang, GeneralUtility\fixed_lgd_cs(), AbstractLinkHandler\getBackendUser(), AbstractLinkHandler\getLanguageService(), and BackendUtility\getRecordWSOL().

getBodyTagAttributes

(

)

Returns

string[] Array of body-tag attributes

Implements LinkHandlerInterface.

Definition at line 268 of file PageLinkHandler.php.

getDatabaseConnection ( )

protected

Returns

DatabaseConnection

Definition at line 337 of file PageLinkHandler.php.

References $GLOBALS.

Referenced by PageLinkHandler\expandPage().

getScriptUrl

(

)

Returns the URL of the current script

Returns

string

Implements LinkParameterProviderInterface.

Definition at line 306 of file PageLinkHandler.php.

getTemporaryTreeMountCancelNotice ( )

protected

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

Returns

string HTML code

Definition at line 226 of file PageLinkHandler.php.

References AbstractLinkHandler\getBackendUser(), AbstractLinkHandler\getLanguageService(), AbstractMessage\INFO, GeneralUtility\linkThisScript(), and GeneralUtility\makeInstance().

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 LinkParameterProviderInterface.

Definition at line 283 of file PageLinkHandler.php.

References PageLinkHandler\expandPage().

isCurrentlySelectedItem

(

array

$values

)

Parameters

array

$values

Values to be checked

Returns

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

Implements LinkParameterProviderInterface.

Definition at line 296 of file PageLinkHandler.php.

modifyLinkAttributes

(

array

$fieldDefinitions

)

Parameters

string[]

$fieldDefinitions Array of link attribute field definitions

Returns

string[]

Implements LinkHandlerInterface.

Definition at line 315 of file PageLinkHandler.php.

References AbstractLinkHandler\getLanguageService().

setTemporaryDbMounts ( )

protected

Returns

void

Definition at line 240 of file PageLinkHandler.php.

References GeneralUtility\_GET(), AbstractLinkHandler\getBackendUser(), and GeneralUtility\intExplode().

Member Data Documentation

$expandPage = 0

protected

Definition at line 36 of file PageLinkHandler.php.

$linkParts = []

protected

Definition at line 43 of file PageLinkHandler.php.

Referenced by PageLinkHandler\canHandleLink().