RecordBrowser extends DatabaseBrowser

Extends the DatabaseBrowser for the specific needs of the LinkBrowser.

Mostly this is about being able to set to some parameters that cannot be set from outside the DatabaseBrowser.

Internal

This class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.

Table of Contents

Properties

$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.
$expandPage  : int|null
When you click a page title/expand icon to see the content of a certain page, this value will contain the ID of the expanded page.
$iconFactory  : IconFactory
$modTSconfig  : array<string|int, mixed>
$moduleTemplate  : ModuleTemplate
$moduleTemplateFactory  : ModuleTemplateFactory
$pageRenderer  : PageRenderer
$request  : ServerRequestInterface|null
$thisScript  : string
URL of current request
$uriBuilder  : UriBuilder
$urlParameters  : array<string|int, mixed>

Methods

__construct()  : mixed
displayRecordsForPage()  : string
getScriptUrl()  : string
Returns the URL of the current script
getUrlParameters()  : array<string|int, string>
Provides an array or GET parameters for URL generation
isCurrentlySelectedItem()  : bool
Check if given value is currently the selected item
processSessionData()  : array<int, array<string|int, mixed>|bool>
Session data for this class can be set from outside with this method.
render()  : string
setRequest()  : void
determineScriptUrl()  : mixed
Sets the script url depending on being a module or script request
getBackendUser()  : BackendUserAuthentication
getBodyTagAttributes()  : array<string, string>
getBParamDataAttributes()  : array<string, string>
Splits parts of $this->bparams and returns needed data attributes for the Javascript
getLanguageService()  : LanguageService
getRequest()  : ServerRequestInterface
initialize()  : mixed
Main initialization
initVariables()  : mixed
Avoid any initialization
renderSearchBox()  : string
renderTableRecords()  : string
This lists all content elements for the given list of tables
setBodyTagParameters()  : mixed
Initialize the body tag for the module

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

$expandPage

When you click a page title/expand icon to see the content of a certain page, this value will contain the ID of the expanded page.

protected int|null $expandPage

If the value is NOT set by GET parameter, then it will be restored from the module session data.

$modTSconfig

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

$request

protected ServerRequestInterface|null $request = null

$thisScript

URL of current request

protected string $thisScript = ''

$urlParameters

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

Methods

displayRecordsForPage()

public displayRecordsForPage(int $selectedPage, string $tables, array<string|int, mixed> $urlParameters) : string
Parameters
$selectedPage : int

Id of page

$tables : string

Comma separated list of tables

$urlParameters : array<string|int, mixed>

url parameters

Return values
string

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

isCurrentlySelectedItem()

Check if given value is currently the selected item

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

Values to be checked

Return values
bool —

Returns TRUE if the given values match the currently selected item

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

render()

public render() : string
Return values
string —

HTML content

setRequest()

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

determineScriptUrl()

Sets the script url depending on being a module or script request

protected determineScriptUrl() : mixed

getBodyTagAttributes()

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

Array of body-tag attributes

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

initialize()

Main initialization

protected initialize() : mixed

initVariables()

Avoid any initialization

protected initVariables() : mixed

renderTableRecords()

This lists all content elements for the given list of tables

protected renderTableRecords(string $tables) : string
Parameters
$tables : string

Comma separated list of tables. Set to "*" if you want all tables.

Return values
string —

HTML code

setBodyTagParameters()

Initialize the body tag for the module

protected setBodyTagParameters() : mixed 

        

        
    




    

    
                            
            

                            
    

        On this page

        
    


            

                    
        

    

        

            
Search results