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
Active with TYPO3 Element Browser: Contains the name of the form field for which this window opens - thus allows us to make references back to the main window in which the form is.
$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
$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>
Splits parts of $this->bparams and returns needed data attributes for the Javascript
getLanguageService()  : LanguageService
getNormalizedParams()  : NormalizedParams
getRequest()  : ServerRequestInterface
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
getViewModeButton()  : ButtonInterface
initialize()  : void
Loads additional JavaScript
initSelectedFolder()  : void
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

Active with TYPO3 Element Browser: Contains the name of the form field for which this window opens - thus allows us to make references back to the main window in which the form is.

protected string $bparams = ''

Example value: "data[pages][39][bodytext]|||tt_content|" or "data[tt_content][NEW3fba56fde763d][image]|||gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai|" Values: 0: form field name reference, eg. "data[tt_content][123][image]" 1: htmlArea RTE parameters: editorNo:contentTypo3Language 2: RTE config parameters: RTEtsConfigParams 3: allowed types. Eg. "tt_content" or "gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai" 4: IRRE uniqueness: target level object-id to perform actions/checks on, eg. "data-4-pages-4-nav_icon-sys_file_reference" ("data--

---<foreign_table>")

$pArr = explode('|', $this->bparams); $formFieldName = $pArr[0]; $allowedTablesOrFileTypes = $pArr[3];

$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

Methods

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

Splits parts of $this->bparams and returns needed data attributes for the Javascript

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

Data attributes for Javascript

getRequest()

protected getRequest() : ServerRequestInterface
Return values
ServerRequestInterface

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.

initialize()

Loads additional JavaScript

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

initSelectedFolder()

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