BrowseLinksController extends AbstractLinkBrowserController
Extended controller for link browser
This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
Table of Contents
Properties
- $additionalAttributes : array<string|int, mixed>
- $buttonConfig : array<string|int, mixed>
- $classesAnchorClassTitle : array<string|int, mixed>
- $classesAnchorDefault : array<string|int, mixed>
- $classesAnchorDefaultTarget : array<string|int, mixed>
- $classesAnchorDefaultTitle : array<string|int, mixed>
- $classesAnchorJSOptions : array<string|int, mixed>
- $contentLanguageService : LanguageService
- Language service object for localization to the content language
- $contentsLanguage : string
- TYPO3 language code of the content language
- $currentLinkHandler : LinkHandlerInterface|null
- Link handler responsible for the current active link
- $currentLinkHandlerId : string
- The ID of the currently active link handler
- $currentLinkParts : array<string, mixed>
- All parts of the current link
- $defaultLinkTarget : string
- $dependencyOrderingService : DependencyOrderingService
- $displayedLinkHandler : LinkHandlerInterface
- Link handler to be displayed
- $displayedLinkHandlerId : string
- The ID of the displayed link handler
- $editorId : string
- $hookObjects : array<string|int, mixed>
- $linkAttributeFields : array<string|int, string>
- List of available link attribute fields
- $linkAttributeValues : array<string|int, string>
- Values of the link attributes
- $linkHandlers : array<string, array<string|int, mixed>>
- $linkService : LinkService
- $moduleTemplate : ModuleTemplate
- $moduleTemplateFactory : ModuleTemplateFactory
- $pageRenderer : PageRenderer
- $parameters : array<string|int, mixed>
- $siteUrl : string
- $thisConfig : array<string|int, mixed>
- $thisScript : string
- URL of current request
- $uriBuilder : UriBuilder
Methods
- __construct() : mixed
- getConfiguration() : array<string|int, mixed>
- Retrieve the configuration
- getParameters() : array<string|int, mixed>
- getScriptUrl() : string
- getUrlParameters() : array<string|int, mixed>
- mainAction() : ResponseInterface
- 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
- buildMenuArray() : array<string|int, array<string|int, mixed>>
- Returns an array definition of the top menu
- determineScriptUrl() : mixed
- Sets the script url depending on being a module or script request
- getAllowedItems() : array<string|int, string>
- Get the allowed items or tabs
- getAllowedLinkAttributes() : array<string|int, string>
- Get the allowed link attributes
- getBackendUser() : BackendUserAuthentication
- getBodyTagAttributes() : array<string|int, string>
- Get attributes for the body tag
- getClassField() : string
- Return html code for the class selector
- getCurrentPageId() : int
- Return the ID of current page
- getDisplayedLinkHandlerId() : string
- getLanguageService() : LanguageService
- getLinkAttributeFieldDefinitions() : array<string|int, string>
- Create an array of link attribute field rendering definitions
- getLinkHandlers() : array<string, array<string|int, mixed>>
- Reads the configured link handlers from page TSconfig
- getPageConfigLabel() : string
- Localize a label obtained from Page TSConfig
- getRelField() : string
- Add rel field
- getTargetField() : string
- Add target selector
- getTitleField() : string
- Add title selector
- init() : mixed
- Initialize controller
- initCurrentUrl() : mixed
- Initialize $this->currentLink and $this->currentLinkHandler
- initDocumentTemplate() : mixed
- Initialize body tag parameters, but can be used for other parts as well
- initHookObjects() : mixed
- Initialize hook objects implementing the interface
- initVariables() : mixed
- isReadonlyTitle() : bool
- loadLinkHandlers() : mixed
- renderCurrentUrl() : mixed
- Add the currently set URL to the view
- renderLinkAttributeFields() : string
- Renders the link attributes for the selected link handler
Properties
$additionalAttributes
protected
array<string|int, mixed>
$additionalAttributes
= []
$buttonConfig
protected
array<string|int, mixed>
$buttonConfig
= []
$classesAnchorClassTitle
protected
array<string|int, mixed>
$classesAnchorClassTitle
= []
$classesAnchorDefault
protected
array<string|int, mixed>
$classesAnchorDefault
= []
$classesAnchorDefaultTarget
protected
array<string|int, mixed>
$classesAnchorDefaultTarget
= []
$classesAnchorDefaultTitle
protected
array<string|int, mixed>
$classesAnchorDefaultTitle
= []
$classesAnchorJSOptions
protected
array<string|int, mixed>
$classesAnchorJSOptions
= []
$contentLanguageService
Language service object for localization to the content language
protected
LanguageService
$contentLanguageService
$contentsLanguage
TYPO3 language code of the content language
protected
string
$contentsLanguage
$currentLinkHandler
Link handler responsible for the current active link
protected
LinkHandlerInterface|null
$currentLinkHandler
$currentLinkHandlerId
The ID of the currently active link handler
protected
string
$currentLinkHandlerId
$currentLinkParts
All parts of the current link
protected
array<string, mixed>
$currentLinkParts
= []
Comprised of url information and additional link parameters.
$defaultLinkTarget
protected
string
$defaultLinkTarget
= ''
$dependencyOrderingService
protected
DependencyOrderingService
$dependencyOrderingService
$displayedLinkHandler
Link handler to be displayed
protected
LinkHandlerInterface
$displayedLinkHandler
$displayedLinkHandlerId
The ID of the displayed link handler
protected
string
$displayedLinkHandlerId
= ''
This is read from the 'act' GET parameter
$editorId
protected
string
$editorId
$hookObjects
protected
array<string|int, mixed>
$hookObjects
= []
$linkAttributeFields
List of available link attribute fields
protected
array<string|int, string>
$linkAttributeFields
= []
$linkAttributeValues
Values of the link attributes
protected
array<string|int, string>
$linkAttributeValues
= []
$linkHandlers
protected
array<string, array<string|int, mixed>>
$linkHandlers
= []
$linkService
protected
LinkService
$linkService
$moduleTemplate
protected
ModuleTemplate
$moduleTemplate
$moduleTemplateFactory
protected
ModuleTemplateFactory
$moduleTemplateFactory
$pageRenderer
protected
PageRenderer
$pageRenderer
$parameters
protected
array<string|int, mixed>
$parameters
$siteUrl
protected
string
$siteUrl
= ''
$thisConfig
protected
array<string|int, mixed>
$thisConfig
= []
$thisScript
URL of current request
protected
string
$thisScript
= ''
$uriBuilder
protected
UriBuilder
$uriBuilder
Methods
__construct()
public
__construct(DependencyOrderingService $dependencyOrderingService, PageRenderer $pageRenderer, UriBuilder $uriBuilder, LinkService $linkService, ModuleTemplateFactory $moduleTemplateFactory) : mixed
Parameters
- $dependencyOrderingService : DependencyOrderingService
- $pageRenderer : PageRenderer
- $uriBuilder : UriBuilder
- $linkService : LinkService
- $moduleTemplateFactory : ModuleTemplateFactory
getConfiguration()
Retrieve the configuration
public
getConfiguration() : array<string|int, mixed>
This is only used by RTE currently.
Return values
array<string|int, mixed>getParameters()
public
getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>getScriptUrl()
public
getScriptUrl() : string
Return values
stringgetUrlParameters()
public
getUrlParameters([array<string|int, mixed> $overrides = null ]) : array<string|int, mixed>
Parameters
- $overrides : array<string|int, mixed> = null
Return values
array<string|int, mixed> —Array of parameters which have to be added to URLs
mainAction()
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
public
mainAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
-
the current request
Return values
ResponseInterface —the response with the content
buildMenuArray()
Returns an array definition of the top menu
protected
buildMenuArray() : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, mixed>>determineScriptUrl()
Sets the script url depending on being a module or script request
protected
determineScriptUrl(ServerRequestInterface $request) : mixed
Parameters
- $request : ServerRequestInterface
Tags
getAllowedItems()
Get the allowed items or tabs
protected
getAllowedItems() : array<string|int, string>
Return values
array<string|int, string>getAllowedLinkAttributes()
Get the allowed link attributes
protected
getAllowedLinkAttributes() : array<string|int, string>
Return values
array<string|int, string>getBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetBodyTagAttributes()
Get attributes for the body tag
protected
getBodyTagAttributes() : array<string|int, string>
Return values
array<string|int, string> —Array of body-tag attributes
getClassField()
Return html code for the class selector
protected
getClassField() : string
Return values
string —the html code to be added to the form
getCurrentPageId()
Return the ID of current page
protected
getCurrentPageId() : int
Return values
intgetDisplayedLinkHandlerId()
protected
getDisplayedLinkHandlerId() : string
Return values
stringgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetLinkAttributeFieldDefinitions()
Create an array of link attribute field rendering definitions
protected
getLinkAttributeFieldDefinitions() : array<string|int, string>
Return values
array<string|int, string>getLinkHandlers()
Reads the configured link handlers from page TSconfig
protected
getLinkHandlers() : array<string, array<string|int, mixed>>
Return values
array<string, array<string|int, mixed>>getPageConfigLabel()
Localize a label obtained from Page TSConfig
protected
getPageConfigLabel(string $string[, bool $JScharCode = true ]) : string
Parameters
- $string : string
-
The label to be localized
- $JScharCode : bool = true
-
If needs to be converted to an array of char numbers
Return values
string —Localized string
getRelField()
Add rel field
protected
getRelField() : string
Return values
stringgetTargetField()
Add target selector
protected
getTargetField() : string
Return values
stringgetTitleField()
Add title selector
protected
getTitleField() : string
Return values
stringinit()
Initialize controller
protected
init() : mixed
initCurrentUrl()
Initialize $this->currentLink and $this->currentLinkHandler
protected
initCurrentUrl() : mixed
initDocumentTemplate()
Initialize body tag parameters, but can be used for other parts as well
protected
initDocumentTemplate() : mixed
initHookObjects()
Initialize hook objects implementing the interface
protected
initHookObjects() : mixed
Tags
initVariables()
protected
initVariables(ServerRequestInterface $request) : mixed
Parameters
- $request : ServerRequestInterface
isReadonlyTitle()
protected
isReadonlyTitle() : bool
Return values
boolloadLinkHandlers()
protected
loadLinkHandlers() : mixed
Tags
renderCurrentUrl()
Add the currently set URL to the view
protected
renderCurrentUrl() : mixed
renderLinkAttributeFields()
Renders the link attributes for the selected link handler
protected
renderLinkAttributeFields() : string