‪TYPO3CMS  10.4
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController Class Reference
Inheritance diagram for TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController:
TYPO3\CMS\Backend\Controller\LinkBrowserController TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController

Public Member Functions

 __construct ()
 
ResponseInterface mainAction (ServerRequestInterface $request)
 
array getUrlParameters (array $overrides=null)
 
array getParameters ()
 
array getConfiguration ()
 
string getScriptUrl ()
 

Public Attributes

return $linkHandlers
 

Protected Member Functions

 init ()
 
 initHookObjects ()
 
 determineScriptUrl (ServerRequestInterface $request)
 
 initVariables (ServerRequestInterface $request)
 
 loadLinkHandlers ()
 
array< string, getLinkHandlers() { $linkHandlers=(array)(BackendUtility::getPagesTSconfig( $this->getCurrentPageId())[ 'TCEMAIN.'][ 'linkHandler.'] ??[]);foreach( $this->hookObjects as $hookObject) { if(method_exists( $hookObject, 'modifyLinkHandlers')) { $linkHandlers=$hookObject-> modifyLinkHandlers ($linkHandlers, $this->currentLinkParts)
 
 initCurrentUrl ()
 
 initDocumentTemplate ()
 
 renderCurrentUrl ()
 
mixed[][] buildMenuArray ()
 
string[] getAllowedItems ()
 
string[] getAllowedLinkAttributes ()
 
string renderLinkAttributeFields ()
 
string[] getLinkAttributeFieldDefinitions ()
 
string[] getBodyTagAttributes ()
 
int getCurrentPageId ()
 
string getDisplayedLinkHandlerId ()
 
LanguageService getLanguageService ()
 
BackendUserAuthentication getBackendUser ()
 

Protected Attributes

ModuleTemplate $moduleTemplate
 
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 108 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 316 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 181 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 373 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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 397 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getBackendUser ( )
protected
Returns
‪BackendUserAuthentication

Definition at line 598 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 521 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 566 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.

◆ getDisplayedLinkHandlerId()

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getDisplayedLinkHandlerId ( )
protected
Returns
‪string

Definition at line 574 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 590 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(), and TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\loadLinkHandlers().

◆ 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 440 of file AbstractLinkBrowserController.php.

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

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

◆ getParameters()

array TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getParameters ( )
Returns
‪array

Definition at line 556 of file AbstractLinkBrowserController.php.

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

◆ getScriptUrl()

string TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::getScriptUrl ( )
Returns
‪string

Definition at line 582 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 508 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 120 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 262 of file AbstractLinkBrowserController.php.

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

◆ initDocumentTemplate()

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

Initialize body tag parameters, but can be used for other parts as well

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

Definition at line 296 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 130 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 194 of file AbstractLinkBrowserController.php.

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

◆ loadLinkHandlers()

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

Definition at line 205 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\$linkHandlers, TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getLanguageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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 147 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().

◆ modifyLinkHandlers()

array<string, getLinkHandlers() { $linkHandlers = (array)(BackendUtility::getPagesTSconfig($this->getCurrentPageId())['TCEMAIN.']['linkHandler.'] ?? []); foreach ($this->hookObjects as $hookObject) { if (method_exists($hookObject, 'modifyLinkHandlers')) { $linkHandlers = $hookObject-> TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::modifyLinkHandlers (   $linkHandlers,
  $this-> 
)
protected

Reads the configured link handlers from page TSconfig

Returns
‪array<string, array<mixed>>

◆ renderCurrentUrl()

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

Add the currently set URL to the view

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

Definition at line 306 of file AbstractLinkBrowserController.php.

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 415 of file AbstractLinkBrowserController.php.

References TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController\getAllowedLinkAttributes(), 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 67 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 73 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 61 of file AbstractLinkBrowserController.php.

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

◆ $displayedLinkHandler

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

Link handler to be displayed

$displayedLinkHandler

Definition at line 79 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 87 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\Recordlist\Controller\AbstractLinkBrowserController\getUrlParameters(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getUrlParameters(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\isReadonlyTitle(), and TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\renderLinkAttributeFields().

◆ $hookObjects

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

Definition at line 103 of file AbstractLinkBrowserController.php.

◆ $linkAttributeFields

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

List of available link attribute fields

Definition at line 93 of file AbstractLinkBrowserController.php.

◆ $linkAttributeValues

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

Values of the link attributes

Definition at line 99 of file AbstractLinkBrowserController.php.

◆ $linkHandlers [1/2]

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

Definition at line 53 of file AbstractLinkBrowserController.php.

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

◆ $linkHandlers [2/2]

return TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$linkHandlers

Definition at line 256 of file AbstractLinkBrowserController.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController::$moduleTemplate
protected

Definition at line 39 of file AbstractLinkBrowserController.php.

◆ $parameters

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

Definition at line 43 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\Recordlist\Controller\AbstractLinkBrowserController\getUrlParameters(), and TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\getUrlParameters().

◆ $thisScript

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

URL of current request

Definition at line 49 of file AbstractLinkBrowserController.php.

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