TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController Class Reference

Inheritance diagram for TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController:

Public Member Functions
	__construct ()
ResponseInterface	mainAction (ServerRequestInterface $request)
array	getUrlParameters (array $overrides=null)
array	getParameters ()
array	getConfiguration ()
string	getScriptUrl ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed	__call (string $methodName, array $arguments)

Protected Member Functions
	init ()
	initHookObjects ()
	determineScriptUrl (ServerRequestInterface $request)
	initVariables (ServerRequestInterface $request)
	loadLinkHandlers ()
array	getLinkHandlers ()
	initCurrentUrl ()
	initDocumentTemplate ()
string	renderCurrentUrl ()
mixed[][]	buildMenuArray ()
string[]	getAllowedItems ()
string[]	getAllowedLinkAttributes ()
string	renderLinkAttributeFields ()
string[]	getLinkAttributeFieldDefinitions ()
string[]	getBodyTagAttributes ()
int	getCurrentPageId ()
string	getDisplayedLinkHandlerId ()
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
array	$deprecatedPublicMethods
DocumentTemplate	$doc
array	$parameters
string	$thisScript = ''
LinkHandlerInterface[]	$linkHandlers = array( )
string[]	$currentLinkParts = array( )
LinkHandlerInterface	$currentLinkHandler
string	$currentLinkHandlerId
LinkHandlerInterface	$displayedLinkHandler
string	$displayedLinkHandlerId = ''
string[]	$linkAttributeFields = array( )
string[]	$linkAttributeValues = array( )
array	$hookObjects = array( )

Detailed Description

Script class for the Link Browser window.

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

Definition at line 35 of file AbstractLinkBrowserController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::__construct

(

)

Constructor

Definition at line 116 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\init(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\initHookObjects().

Member Function Documentation

buildMenuArray()

mixed [][] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::buildMenuArray ( )

protected

Returns an array definition of the top menu

Returns

‪mixed[][]

Definition at line 348 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$currentLinkHandler, TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$currentLinkHandlerId, TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$displayedLinkHandlerId, TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getAllowedItems(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getUrlParameters().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

determineScriptUrl()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::determineScriptUrl ( ServerRequestInterface  $request )

protected

Sets the script url depending on being a module or script request

Parameters

ServerRequestInterface

$request

Exceptions

Definition at line 199 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

getAllowedItems()

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getAllowedItems ( )

protected

Get the allowed items or tabs

Returns

‪string[]

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 405 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\buildMenuArray().

getAllowedLinkAttributes()

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getAllowedLinkAttributes ( )

protected

Get the allowed link attributes

Returns

‪string[]

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 429 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\renderLinkAttributeFields().

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getBackendUser ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 638 of file AbstractLinkBrowserController.php.

References $GLOBALS.

getBodyTagAttributes()

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getBodyTagAttributes ( )

protected

Get attributes for the body tag

Returns

‪string[] Array of body-tag attributes

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController, and TYPO3\CMS\Backend\Controller\LinkBrowserController.

Definition at line 561 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$parameters, TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getUrlParameters().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\initDocumentTemplate().

getConfiguration()

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getConfiguration

(

)

Retrieve the configuration

Returns

‪array

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController, and TYPO3\CMS\Backend\Controller\LinkBrowserController.

Definition at line 606 of file AbstractLinkBrowserController.php.

getCurrentPageId()

int TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getCurrentPageId ( )

abstractprotected

Return the ID of current page

Returns

‪int

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController, and TYPO3\CMS\Backend\Controller\LinkBrowserController.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLinkHandlers().

getDisplayedLinkHandlerId()

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getDisplayedLinkHandlerId ( )

protected

Returns

‪string

Definition at line 614 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$displayedLinkHandlerId.

getLanguageService()

LanguageService TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getLanguageService ( )

protected

Returns

‪LanguageService

Definition at line 630 of file AbstractLinkBrowserController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getClassField(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLinkAttributeFieldDefinitions(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getPageConfigLabel(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getRelField(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getTargetField(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getTitleField(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\init(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\loadLinkHandlers(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\renderCurrentUrl(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\renderCurrentUrl(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\renderLinkAttributeFields().

getLinkAttributeFieldDefinitions()

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getLinkAttributeFieldDefinitions ( )

protected

Create an array of link attribute field rendering definitions

Returns

‪string[]

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 480 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLanguageService().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\renderLinkAttributeFields().

getLinkHandlers()

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getLinkHandlers ( )

protected

Reads the configured link handlers from page TSconfig

Returns

‪array

Definition at line 265 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$linkHandlers, TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getCurrentPageId(), and TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\loadLinkHandlers().

getParameters()

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getParameters

(

)

Returns

‪array

Definition at line 596 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$parameters.

getScriptUrl()

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getScriptUrl

(

)

Returns

‪string

Definition at line 622 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$thisScript.

getUrlParameters()

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getUrlParameters

(

array

$overrides = null

)

Parameters

array

$overrides

Returns

‪array Array of parameters which have to be added to URLs

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 548 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$displayedLinkHandlerId, and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$parameters.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\buildMenuArray(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getBodyTagAttributes().

init()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::init ( )

protected

Initialize the controller

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 125 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\includeLLFile().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\__construct().

initCurrentUrl()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::initCurrentUrl ( )

protected

Initialize $this->currentLinkParts and $this->currentLinkHandler

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController, and TYPO3\CMS\Backend\Controller\LinkBrowserController.

Definition at line 280 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

initDocumentTemplate()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::initDocumentTemplate ( )

protected

Initialize document template object

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController, and TYPO3\CMS\Backend\Controller\LinkBrowserController.

Definition at line 314 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getBodyTagAttributes().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

initHookObjects()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::initHookObjects ( )

protected

Initialize hook objects implementing the interface

Exceptions

Definition at line 135 of file AbstractLinkBrowserController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\__construct().

initVariables()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::initVariables ( ServerRequestInterface  $request )

protected

Parameters

ServerRequestInterface

$request

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 212 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

loadLinkHandlers()

TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::loadLinkHandlers ( )

protected

Exceptions

Definition at line 223 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$linkHandlers, TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLanguageService(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLinkHandlers().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

mainAction()

ResponseInterface TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::mainAction

(

ServerRequestInterface

$request

)

Injects the request object for the current request or subrequest As this controller goes only through the main() method, it is rather simple for now

Parameters

ServerRequestInterface

$request

‪the current request

Returns

‪ResponseInterface the response with the content

Definition at line 152 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\buildMenuArray(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\determineScriptUrl(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\initCurrentUrl(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\initDocumentTemplate(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\initVariables(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\loadLinkHandlers(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\renderCurrentUrl(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\renderLinkAttributeFields().

renderCurrentUrl()

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::renderCurrentUrl ( )

protected

Render the currently set URL

Returns

‪string

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 333 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLanguageService().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

renderLinkAttributeFields()

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::renderLinkAttributeFields ( )

protected

Renders the link attributes for the selected link handler

Returns

‪string

Reimplemented in TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController.

Definition at line 447 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getAllowedLinkAttributes(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLanguageService(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLinkAttributeFieldDefinitions().

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\mainAction().

Member Data Documentation

$currentLinkHandler

LinkHandlerInterface TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$currentLinkHandler

protected

Link handler responsible for the current active link

$currentLinkHandler

Definition at line 75 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\buildMenuArray().

$currentLinkHandlerId

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$currentLinkHandlerId

protected

The ID of the currently active link handler

Definition at line 81 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\buildMenuArray().

$currentLinkParts

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$currentLinkParts = array( )

protected

All parts of the current link

Comprised of url information and additional link parameters.

Definition at line 69 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Backend\Controller\LinkBrowserController\initCurrentUrl().

$deprecatedPublicMethods

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$deprecatedPublicMethods

protected

Initial value:

= array( 
        'renderLinkAttributeFields' => 'Using AbstractLinkBrowserController::renderLinkAttributeFields() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'getDisplayedLinkHandlerId' => 'Using AbstractLinkBrowzerController::getDisplayedLinkHandlerId() is deprecated and will not be possible anymore in TYPO3 v10.0.',
     )

Definition at line 40 of file AbstractLinkBrowserController.php.

$displayedLinkHandler

LinkHandlerInterface TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$displayedLinkHandler

protected

Link handler to be displayed

$displayedLinkHandler

Definition at line 87 of file AbstractLinkBrowserController.php.

$displayedLinkHandlerId

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$displayedLinkHandlerId = ''

protected

The ID of the displayed link handler

This is read from the 'act' GET parameter

Definition at line 95 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\buildMenuArray(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getClassField(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getDisplayedLinkHandlerId(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getTitleField(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getUrlParameters(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getUrlParameters(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\isReadonlyTitle(), and TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\renderLinkAttributeFields().

$doc

DocumentTemplate TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$doc

protected

Definition at line 47 of file AbstractLinkBrowserController.php.

$hookObjects

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$hookObjects = array( )

protected

Definition at line 111 of file AbstractLinkBrowserController.php.

$linkAttributeFields

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$linkAttributeFields = array( )

protected

List of available link attribute fields

Definition at line 101 of file AbstractLinkBrowserController.php.

$linkAttributeValues

string [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$linkAttributeValues = array( )

protected

Values of the link attributes

Definition at line 107 of file AbstractLinkBrowserController.php.

$linkHandlers

LinkHandlerInterface [] TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$linkHandlers = array( )

protected

Definition at line 61 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLinkHandlers(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\loadLinkHandlers().

$parameters

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$parameters

protected

Definition at line 51 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Backend\Controller\LinkBrowserController\getBodyTagAttributes(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getBodyTagAttributes(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getBodyTagAttributes(), TYPO3\CMS\Backend\Controller\LinkBrowserController\getCurrentPageId(), TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getParameters(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getUrlParameters(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getUrlParameters().

$thisScript

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$thisScript = ''

protected

URL of current request

Definition at line 57 of file AbstractLinkBrowserController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getScriptUrl().