DatabaseBrowser extends DatabaseBrowser

Showing a page tree and allows you to browse for records. This is the modal rendered for type=group to add db relations to a group field.

Deprecated

since TYPO3 v12, will be removed in TYPO3 v13

Table of Contents

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.
$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.
$extensionConfiguration  : ExtensionConfiguration
$iconFactory  : IconFactory
$identifier  : string
The element browsers unique identifier
$modTSconfig  : array<string|int, mixed>
$pageRenderer  : PageRenderer
$request  : ServerRequestInterface|null
$thisScript  : string
URL of current request
$uriBuilder  : UriBuilder
$view  : ViewInterface

Methods

__construct()  : mixed
getIdentifier()  : string
Returns the identifier for the browser
getScriptUrl()  : string
Returns the URL of the current script
getUrlParameters()  : array<string, mixed>
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
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
getRegisteredStylesheetFolders()  : array<string|int, mixed>
Return an array of all stylesheet directories registered via $GLOBAlS['TBE_STYLES']['skins'].
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
initialize()  : mixed
Main initialization
initVariables()  : mixed
loadStylesheets()  : void
Load all registered stylesheets from $GLOBALS['TBE_STYLES'] "API"
renderSearchBox()  : string
renderTableRecords()  : string
This lists all content elements for the given list of tables
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];

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

$identifier

The element browsers unique identifier

protected string $identifier = 'db'

$modTSconfig

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

$request

protected ServerRequestInterface|null $request = null

$thisScript

URL of current request

protected string $thisScript = ''

Methods

getIdentifier()

Returns the identifier for the browser

public getIdentifier() : string
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, mixed>
Parameters
$values : array<string|int, mixed>

Array of values to include into the parameters

Return values
array<string, mixed> —

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

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

getRegisteredStylesheetFolders()

Return an array of all stylesheet directories registered via $GLOBAlS['TBE_STYLES']['skins'].

protected getRegisteredStylesheetFolders() : array<string|int, mixed>
Deprecated

will be removed in TYPO3 v13.0. Use $GLOBALS['TYPO3_CONF_VARS']['BE']['stylesheets'] instead.

Return values
array<string|int, mixed>

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

Main initialization

protected initialize() : mixed

initVariables()

protected initVariables() : mixed

loadStylesheets()

Load all registered stylesheets from $GLOBALS['TBE_STYLES'] "API"

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

renderSearchBox()

protected renderSearchBox(ServerRequestInterface $request, ElementBrowserRecordList $dblist, string $searchWord, int $searchLevels) : string
Parameters
$request : ServerRequestInterface
$dblist : ElementBrowserRecordList
$searchWord : string
$searchLevels : int
Return values
string

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

On this page

Search results