BrowseLinksController extends AbstractLinkBrowserController

Extended controller for link browser

Internal

This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.

Attributes
#[Autoconfigure]
$public: true
$shared: false

Table of Contents

Properties

$backendViewFactory  : BackendViewFactory
$buttonConfig  : array<string|int, mixed>
$classesAnchorDefault  : array<string|int, mixed>
$classesAnchorDefaultTarget  : array<string|int, mixed>
$classesAnchorJSOptions  : array<string|int, mixed>
$contentLanguageService  : LanguageService|null
$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|null
Link handler to be displayed
$displayedLinkHandlerId  : string
The ID of the displayed link handler This is read from the 'act' GET parameter
$editorId  : string
$eventDispatcher  : EventDispatcherInterface
$extensionConfiguration  : ExtensionConfiguration
$flashMessageService  : FlashMessageService
$languageServiceFactory  : LanguageServiceFactory
$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
$pageRenderer  : PageRenderer
$parameters  : array<string|int, mixed>
$richtext  : Richtext
$siteUrl  : string
$thisConfig  : array<string|int, mixed>
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
getConfiguration()  : array<string|int, mixed>
This is only used by RTE currently.
getParameters()  : array<string|int, mixed>
getUrlParameters()  : array{act: string, P: array, editorId: string, contentsLanguage: string}
injectBackendViewFactory()  : void
injectDependencyOrderingService()  : void
injectEventDispatcher()  : void
injectExtensionConfiguration()  : void
injectPageRenderer()  : void
injectUriBuilder()  : void
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
getAllowedItems()  : array<string|int, string>
getAllowedLinkAttributes()  : array<string|int, string>
getBackendFavicon()  : string
Retrieves configured favicon for backend with fallback.
getBackendUser()  : BackendUserAuthentication
getBodyTagAttributes()  : array<string|int, string>
getClassField()  : string
Return html code for the class selector
getCurrentPageId()  : int
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
getNormalizedParams()  : NormalizedParams
getPageConfigLabel()  : string
Localize a label obtained from Page TSConfig
getRelField()  : string
getTargetField()  : string
getUriForFileName()  : string
Returns the uri of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the project root of the TYPO3 installation
initCurrentUrl()  : void
Initialize $this->currentLinkParts and $this->currentLinkHandler
initDocumentTemplate()  : void
initVariables()  : void
loadLinkHandlers()  : void
loadStylesheets()  : void
Load all registered stylesheets from $GLOBALS['TYPO3_CONF_VARS']['BE']['stylesheets']
renderCurrentUrl()  : void
Add the currently set URL to the view
renderLinkAttributeFields()  : string
Renders the link attributes for the selected link handler
setUpBasicPageRendererForBackend()  : void
Sets mandatory parameters for the PageRenderer.

Properties

$buttonConfig

protected array<string|int, mixed> $buttonConfig = []

$classesAnchorDefault

protected array<string|int, mixed> $classesAnchorDefault = []

$classesAnchorDefaultTarget

protected array<string|int, mixed> $classesAnchorDefaultTarget = []

$classesAnchorJSOptions

protected array<string|int, mixed> $classesAnchorJSOptions = []

$contentsLanguage

TYPO3 language code of the content language

protected string $contentsLanguage

$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 = ''

$displayedLinkHandlerId

The ID of the displayed link handler This is read from the 'act' GET parameter

protected string $displayedLinkHandlerId = ''

$eventDispatcher

protected EventDispatcherInterface $eventDispatcher

$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 = []

$parameters

protected array<string|int, mixed> $parameters

$thisConfig

protected array<string|int, mixed> $thisConfig = []

Methods

getConfiguration()

This is only used by RTE currently.

public getConfiguration() : array<string|int, mixed>
Return values
array<string|int, mixed>

getParameters()

public getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUrlParameters()

public getUrlParameters([array<string|int, mixed>|null $overrides = null ]) : array{act: string, P: array, editorId: string, contentsLanguage: string}
Parameters
$overrides : array<string|int, mixed>|null = null
Return values
array{act: string, P: array, editorId: string, contentsLanguage: string} —

Array of parameters which have to be added to URLs

injectEventDispatcher()

public injectEventDispatcher(EventDispatcherInterface $eventDispatcher) : void
Parameters
$eventDispatcher : EventDispatcherInterface

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(ServerRequestInterface $request) : array<string|int, array<string|int, mixed>>
Parameters
$request : ServerRequestInterface
Return values
array<string|int, array<string|int, mixed>>

getAllowedItems()

protected getAllowedItems() : array<string|int, string>
Return values
array<string|int, string>

getAllowedLinkAttributes()

protected getAllowedLinkAttributes() : array<string|int, string>
Return values
array<string|int, string>

getBackendFavicon()

Retrieves configured favicon for backend with fallback.

protected getBackendFavicon(ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request) : string
Parameters
$extensionConfiguration : ExtensionConfiguration
$request : ServerRequestInterface
Return values
string

getBodyTagAttributes()

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

protected getCurrentPageId() : int
Return values
int

getDisplayedLinkHandlerId()

protected getDisplayedLinkHandlerId() : string
Return values
string

getLinkAttributeFieldDefinitions()

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 it needs to be converted to an array of char numbers

Return values
string —

Localized string

getRelField()

protected getRelField() : string
Return values
string

getTargetField()

protected getTargetField() : string
Return values
string

getUriForFileName()

Returns the uri of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the project root of the TYPO3 installation

protected getUriForFileName(ServerRequestInterface $request, string $filename) : string
Parameters
$request : ServerRequestInterface
$filename : string

The input filename/filepath to evaluate

Return values
string —

Returns the filename of $filename if valid, otherwise blank string.

initCurrentUrl()

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

protected initCurrentUrl() : void

initDocumentTemplate()

protected initDocumentTemplate() : void

initVariables()

protected initVariables(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface

loadLinkHandlers()

protected loadLinkHandlers() : void
Tags
throws
UnexpectedValueException

loadStylesheets()

Load all registered stylesheets from $GLOBALS['TYPO3_CONF_VARS']['BE']['stylesheets']

protected loadStylesheets(PageRenderer $pageRenderer) : void
Parameters
$pageRenderer : PageRenderer

renderLinkAttributeFields()

Renders the link attributes for the selected link handler

protected renderLinkAttributeFields(ViewInterface $view) : string
Parameters
$view : ViewInterface
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results