TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser Class Reference

Inheritance diagram for TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser:

Public Member Functions
string	render ()
string[]	getUrlParameters (array $values)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser
	__construct (protected readonly IconFactory $iconFactory, protected readonly PageRenderer $pageRenderer, protected readonly UriBuilder $uriBuilder, protected readonly ExtensionConfiguration $extensionConfiguration, protected readonly BackendViewFactory $backendViewFactory,)
	getIdentifier ()
array< string, getBodyTagAttributes() { return[];} protected array< string, function getBParamDataAttributes() { $params=explode('|', $this->bparams);$fieldRef=$params[0] ?? null;$rteParams=$params[1] ?? null;$rteConfig=$params[2] ?? null;$irreObjectId=$params[4] ?? null;return['data-form-field-name'=> 'data[' . $fieldRef . '][' . $rteParams . '][' . $rteConfig . ']', 'data-field-reference'=> function	setRequest (ServerRequestInterface $request)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\ElementBrowser\ElementBrowserInterface
	getIdentifier ()
array[]	processSessionData ($data)

Public Attributes
array< int, function processSessionData( $data) { if( $this->expandPage !==null) { $data[ 'expandPage']=$this->	expandPage
	$store = true
	else
	return [$data, $store]

Protected Member Functions
	initialize (ServerRequestInterface $request)
	initVariables (ServerRequestInterface $request)
string	renderTableRecords ($tables)
	renderSearchBox (ServerRequestInterface $request, ElementBrowserRecordList $dblist, string $searchWord, int $searchLevels)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser
	getBodyTagParameters ()
	getRequest ()
	getLanguageService ()
	getBackendUser ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Template\PageRendererBackendSetupTrait
	setUpBasicPageRendererForBackend (PageRenderer $pageRenderer, ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request, LanguageService $languageService,)
	loadStylesheets (PageRenderer $pageRenderer)
	getBackendFavicon (ExtensionConfiguration $extensionConfiguration, ServerRequestInterface $request)
string	getUriForFileName (ServerRequestInterface $request, string $filename)
	getNormalizedParams (ServerRequestInterface $request)

Protected Attributes
string	$identifier = 'db'
int null	$expandPage
array	$modTSconfig = []
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser
string	$identifier = ''
string	$bparams = ''
ServerRequestInterface	$request = null
ViewInterface	$view
array< string, function getBodyTagAttributes() { return[];} protected array< string, function getBParamDataAttributes() { $params=explode('|', $this->bparams);$fieldRef=$params[0] ?? null;$rteParams=$params[1] ?? null;$rteConfig=$params[2] ?? null;$irreObjectId=$params[4] ?? null;return['data-form-field-name'=> 'data[' . $fieldRef . '][' . $rteParams . '][' . $rteConfig . ']', 'data-field-reference'=>	$fieldRef

Detailed Description

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.

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

Definition at line 37 of file DatabaseBrowser.php.

Member Function Documentation

getUrlParameters()

string [] TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::getUrlParameters

(

array

$values

)

Parameters

array

$values

‪Array of values to include into the parameters

Returns

‪string[] Array of parameters which have to be added to URLs

Implements TYPO3\CMS\Backend\Tree\View\LinkParameterProviderInterface.

Definition at line 240 of file DatabaseBrowser.php.

References TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\$bparams, and TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\$expandPage.

Referenced by TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\renderTableRecords().

initialize()

TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::initialize ( ServerRequestInterface  $request )

protected

Main initialization

Reimplemented from TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser.

Definition at line 50 of file DatabaseBrowser.php.

References TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\$request.

initVariables()

TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::initVariables ( ServerRequestInterface  $request )

protected

Reimplemented from TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser.

Definition at line 60 of file DatabaseBrowser.php.

References TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\$request, and TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\expandPage.

render()

string TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::render

(

)

Returns

‪string HTML content

Implements TYPO3\CMS\Backend\ElementBrowser\ElementBrowserInterface.

Definition at line 87 of file DatabaseBrowser.php.

References $GLOBALS, TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\$view, TYPO3\CMS\Core\View\ViewInterface\assignMultiple(), TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\expandPage, TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\getBodyTagParameters(), TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\getRequest(), TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\renderTableRecords(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

renderSearchBox()

TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::renderSearchBox ( ServerRequestInterface  $request, ElementBrowserRecordList  $dblist, string  $searchWord, int  $searchLevels  )

protected

Definition at line 227 of file DatabaseBrowser.php.

References TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\$request, and TYPO3\CMS\Backend\RecordList\DatabaseRecordList\listURL().

Referenced by TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\renderTableRecords().

renderTableRecords()

string TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::renderTableRecords (   $tables )

protected

This lists all content elements for the given list of tables

Parameters

string

$tables

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

Returns

‪string HTML code

Definition at line 138 of file DatabaseBrowser.php.

References $GLOBALS, TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\$request, TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\expandPage, TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Backend\ElementBrowser\AbstractElementBrowser\getRequest(), TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\getUrlParameters(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\renderSearchBox(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\render().

Member Data Documentation

$expandPage

int null TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::$expandPage

protected

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. If the value is NOT set by GET parameter, then it will be restored from the module session data.

Definition at line 47 of file DatabaseBrowser.php.

Referenced by TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\getUrlParameters().

$identifier

string TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::$identifier = 'db'

protected

Definition at line 39 of file DatabaseBrowser.php.

$modTSconfig

array TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::$modTSconfig = []

protected

Definition at line 48 of file DatabaseBrowser.php.

$store

TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::$store = true

Definition at line 76 of file DatabaseBrowser.php.

else

TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::else

Initial value:

{
            $this->‪expandPage = (int)($data['expandPage'] ?? 0)

Definition at line 77 of file DatabaseBrowser.php.

expandPage

array<int, function processSessionData($data) { if ($this->expandPage !== null) { $data['expandPage'] = $this-> TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::expandPage

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

Parameters

mixed[]

$data

‪Session data array

Returns

‪array<int, array|bool> Session data and boolean which indicates that data needs to be stored in session because it's changed

Definition at line 75 of file DatabaseBrowser.php.

Referenced by TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\initVariables(), TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\render(), and TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser\renderTableRecords().

return

TYPO3\CMS\Backend\ElementBrowser\DatabaseBrowser::return[ $data, $store]

Definition at line 81 of file DatabaseBrowser.php.