FolderLinkHandler extends AbstractResourceLinkHandler

Internal

Table of Contents

Properties

$currentPage  : int
$displayThumbs  : string|null
$expandFolder  : string|null
$filelist  : FileList|null
$iconFactory  : IconFactory
$languageService  : LanguageService
$languageServiceFactory  : LanguageServiceFactory
$linkBrowser  : AbstractLinkBrowserController
$linkParts  : array<string|int, mixed>
$moduleStorageIdentifier  : string
$pageRenderer  : PageRenderer
$resourceDisplayMatcher  : Matcher|null
$resourceFactory  : ResourceFactory
$resourceSelectableMatcher  : Matcher|null
$selectedFolder  : Folder|null
$type  : LinkType
$uriBuilder  : UriBuilder
$view  : ViewInterface
$viewMode  : string|null

Methods

__construct()  : mixed
canHandleLink()  : bool
Checks if this is the handler for the given link
createView()  : ViewInterface
formatCurrentUrl()  : string
Format the current link for HTML output
getBodyTagAttributes()  : array<string|int, string>
getLinkAttributes()  : array<string|int, mixed>
getScriptUrl()  : string
Returns the URL of the current script
getUrlParameters()  : array<string|int, string>
Provides an array or GET parameters for URL generation
getView()  : ViewInterface
initialize()  : mixed
Initialize the handler
initializeVariables()  : void
isCurrentlySelectedItem()  : bool
Check if given value is currently the selected item
isUpdateSupported()  : bool
Return TRUE if the handler supports to update a link.
modifyLinkAttributes()  : array<string|int, string>
render()  : string
Render the link handler. Ideally this modifies the view, but it can also render content directly.
setView()  : self
createUri()  : string
getBackendUser()  : BackendUserAuthentication
getLanguageService()  : LanguageService
getViewModeButton()  : ButtonInterface

Properties

$currentPage

protected int $currentPage = 1

$displayThumbs

protected string|null $displayThumbs = null

$expandFolder

protected string|null $expandFolder = null

$linkParts

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

$moduleStorageIdentifier

protected string $moduleStorageIdentifier = 'media_management'

$resourceSelectableMatcher

protected Matcher|null $resourceSelectableMatcher = null

$viewMode

protected string|null $viewMode = null

Methods

canHandleLink()

Checks if this is the handler for the given link

public canHandleLink(array<string|int, mixed> $linkParts) : bool

The handler may store this information locally for later usage.

Parameters
$linkParts : array<string|int, mixed>

Link parts as returned from TypoLinkCodecService

Return values
bool

formatCurrentUrl()

Format the current link for HTML output

public formatCurrentUrl() : string
Return values
string

getBodyTagAttributes()

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

Array of body-tag attributes

getLinkAttributes()

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

getScriptUrl()

Returns the URL of the current script

public getScriptUrl() : string
Return values
string

getUrlParameters()

Provides an array or GET parameters for URL generation

public getUrlParameters(array<string|int, mixed> $parameters) : array<string|int, string>
Parameters
$parameters : array<string|int, mixed>
Return values
array<string|int, string> —

Array of parameters which have to be added to URLs

initialize()

Initialize the handler

public initialize(AbstractLinkBrowserController $linkBrowser, mixed $identifier, array<string|int, mixed> $configuration) : mixed
Parameters
$linkBrowser : AbstractLinkBrowserController
$identifier : mixed
$configuration : array<string|int, mixed>

Page TSconfig of this link handler: TCEMAIN.linkHandler..configuration

initializeVariables()

public initializeVariables(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface

isCurrentlySelectedItem()

Check if given value is currently the selected item

public isCurrentlySelectedItem(array<string|int, mixed> $values) : bool

This method is only used in the page tree.

Parameters
$values : array<string|int, mixed>

Values to be checked

Return values
bool —

Returns TRUE if the given values match the currently selected item

isUpdateSupported()

Return TRUE if the handler supports to update a link.

public isUpdateSupported() : bool

This is useful for file or page links, when only attributes are changed.

Return values
bool

modifyLinkAttributes()

public modifyLinkAttributes(array<string|int, mixed> $fieldDefinitions) : array<string|int, string>
Parameters
$fieldDefinitions : array<string|int, mixed>

Array of link attribute field definitions

Return values
array<string|int, string>

render()

Render the link handler. Ideally this modifies the view, but it can also render content directly.

public render(ServerRequestInterface $request) : string
Parameters
$request : ServerRequestInterface
Return values
string

createUri()

protected createUri(ServerRequestInterface $request[, array<string|int, mixed> $parameters = [] ]) : string
Parameters
$request : ServerRequestInterface
$parameters : array<string|int, mixed> = []
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results