AbstractResourceBrowser extends AbstractElementBrowser implements ElementBrowserInterface, LinkParameterProviderInterface

AbstractYes

Base class for element browsers This class should only be used internally. Extensions must implement the ElementBrowserInterface.

Internal

Table of Contents

Interfaces

ElementBrowserInterface
Element browsers are modals rendered when records are attached to FormEngine elements.
LinkParameterProviderInterface

Properties

$backendViewFactory  : BackendViewFactory
$bparams  : string
Legacy bparams string - kept for backward compatibility.
$browserParameters  : ElementBrowserParameters
Typed DTO containing all browser parameters.
$componentFactory  : ComponentFactory
$currentPage  : int
$displayThumbs  : bool
$expandFolder  : string|null
$extensionConfiguration  : ExtensionConfiguration
$filelist  : FileList|null
$iconFactory  : IconFactory
$identifier  : string
The element browsers unique identifier
$moduleStorageIdentifier  : string
$pageRenderer  : PageRenderer
$request  : ServerRequestInterface|null
$resourceDisplayMatcher  : Matcher|null
$resourceSelectableMatcher  : Matcher|null
$selectedFolder  : Folder|null
$sortDirection  : SortDirection|null
$sortField  : string
$tcaSchemaFactory  : TcaSchemaFactory
$uriBuilder  : UriBuilder
$view  : ViewInterface
$viewMode  : ViewMode|null

Methods

__construct()  : mixed
getIdentifier()  : string
Returns the identifier for the browser
getUrlParameters()  : array<string|int, string>
Provides an array or GET parameters for URL generation
processSessionData()  : array<int, array<string|int, mixed>|bool>
Session data for this class can be set from outside with this method.
setRequest()  : void
createUri()  : string
getBackendFavicon()  : string
Retrieves configured favicon for backend with fallback.
getBackendUser()  : BackendUserAuthentication
getBodyTagAttributes()  : array<string, string>
getBodyTagParameters()  : string
getBParamDataAttributes()  : array<string, string|null>
Returns data attributes for the body tag, used by the Javascript.
getLanguageService()  : LanguageService
getNormalizedParams()  : NormalizedParams
getRequest()  : ServerRequestInterface
getSortingModeButtons()  : ButtonInterface
getUriForFileName()  : string
Returns the uri for a system resource
getViewModeButton()  : ButtonInterface
initialize()  : void
Loads additional JavaScript
initSelectedFolder()  : void
Last selected folder is stored in user module session. Sanitize it to set $this->selectedFolder or keep it null.
initVariables()  : void
loadStylesheets()  : void
Load all registered stylesheets from $GLOBALS['TYPO3_CONF_VARS']['BE']['stylesheets']
setUpBasicPageRendererForBackend()  : void
Sets mandatory parameters for the PageRenderer.

Properties

$bparams

Legacy bparams string - kept for backward compatibility.

Deprecated

since TYPO3 v14.2, will be removed in TYPO3 v15.0. Use $this->browserParameters instead. Remove this in v15.0 together with ElementBrowserParameters::toBparams() and ::fromBparams()

protected string $bparams = ''

$currentPage

protected int $currentPage = 1

$displayThumbs

protected bool $displayThumbs = true

$expandFolder

protected string|null $expandFolder = null

$identifier

The element browsers unique identifier

protected string $identifier = ''

$moduleStorageIdentifier

protected string $moduleStorageIdentifier = 'media_management'

$request

protected ServerRequestInterface|null $request = null

$resourceSelectableMatcher

protected Matcher|null $resourceSelectableMatcher = null

$sortField

protected string $sortField = 'name'

Methods

__construct()

public __construct(IconFactory $iconFactory, PageRenderer $pageRenderer, UriBuilder $uriBuilder, ExtensionConfiguration $extensionConfiguration, BackendViewFactory $backendViewFactory, TcaSchemaFactory $tcaSchemaFactory, ComponentFactory $componentFactory) : mixed
Parameters
$iconFactory : IconFactory
$pageRenderer : PageRenderer
$uriBuilder : UriBuilder
$extensionConfiguration : ExtensionConfiguration
$backendViewFactory : BackendViewFactory
$tcaSchemaFactory : TcaSchemaFactory
$componentFactory : ComponentFactory

getIdentifier()

Returns the identifier for the browser

public getIdentifier() : string
Return values
string

getUrlParameters()

Provides an array or GET parameters for URL generation

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

Array of values to include into the parameters

Return values
array<string|int, string> —

Array of parameters which have to be added to URLs

processSessionData()

Session data for this class can be set from outside with this method.

public processSessionData(array<string|int, mixed> $data) : array<int, array<string|int, mixed>|bool>
Parameters
$data : array<string|int, mixed>

Session data array

Return values
array<int, array<string|int, mixed>|bool> —

Session data and boolean which indicates that data needs to be stored in session because it's changed

setRequest()

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

createUri()

protected createUri([array<string|int, mixed> $parameters = [] ]) : string
Parameters
$parameters : array<string|int, mixed> = []
Return values
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, string>
Return values
array<string, string> —

Array of body-tag attributes

getBodyTagParameters()

protected getBodyTagParameters() : string
Return values
string

getBParamDataAttributes()

Returns data attributes for the body tag, used by the Javascript.

protected getBParamDataAttributes() : array<string, string|null>
Return values
array<string, string|null> —

Data attributes for Javascript

getRequest()

protected getRequest() : ServerRequestInterface
Return values
ServerRequestInterface

initialize()

Loads additional JavaScript

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

initSelectedFolder()

Last selected folder is stored in user module session. Sanitize it to set $this->selectedFolder or keep it null.

protected initSelectedFolder() : void

initVariables()

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

loadStylesheets()

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

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

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results