LinkBrowserController extends AbstractLinkBrowserController

Extended controller for link browser

Table of Contents

Properties

$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
$dependencyOrderingService  : DependencyOrderingService
$displayedLinkHandler  : LinkHandlerInterface
Link handler to be displayed
$displayedLinkHandlerId  : string
The ID of the displayed link handler
$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>
$thisScript  : string
URL of current request
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
encodeTypoLink()  : ResponseInterface
Encode a typolink via ajax
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
areFieldChangeFunctionsValid()  : bool
Determines whether submitted field change functions are valid and are coming from the system and not from an external abuse.
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
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
init()  : mixed
Initialize the controller
initCurrentUrl()  : mixed
Initialize $this->currentLinkParts
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
loadLinkHandlers()  : mixed
renderCurrentUrl()  : mixed
Add the currently set URL to the view
renderLinkAttributeFields()  : string
Renders the link attributes for the selected link handler
strReplaceRecursively()  : array<string|int, mixed>

Properties

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

$displayedLinkHandlerId

The ID of the displayed link handler

protected string $displayedLinkHandlerId = ''

This is read from the 'act' GET parameter

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

$parameters

protected array<string|int, mixed> $parameters

$thisScript

URL of current request

protected string $thisScript = ''

Methods

encodeTypoLink()

Encode a typolink via ajax

public encodeTypoLink(ServerRequestInterface $request) : ResponseInterface

This avoids to implement the encoding functionality again in JS for the browser.

Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

getConfiguration()

Retrieve the configuration

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>

getScriptUrl()

public getScriptUrl() : string
Return values
string

getUrlParameters()

public getUrlParameters([array<string|int, mixed>|null $overrides = null ]) : array<string|int, mixed>
Parameters
$overrides : array<string|int, mixed>|null = 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

areFieldChangeFunctionsValid()

Determines whether submitted field change functions are valid and are coming from the system and not from an external abuse.

protected areFieldChangeFunctionsValid([bool $handleFlexformSections = false ]) : bool
Parameters
$handleFlexformSections : bool = false

Whether to handle flexform sections differently

Return values
bool —

Whether the submitted field change functions are valid

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

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>

getBodyTagAttributes()

Get attributes for the body tag

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

Array of body-tag attributes

getCurrentPageId()

Return the ID of current page

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

init()

Initialize the controller

protected init() : mixed

initCurrentUrl()

Initialize $this->currentLinkParts

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
throws
UnexpectedValueException

initVariables()

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

loadLinkHandlers()

protected loadLinkHandlers() : mixed
Tags
throws
UnexpectedValueException

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
Return values
string

strReplaceRecursively()

protected strReplaceRecursively(string $search, string $replace, array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$search : string
$replace : string
$array : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results