TYPO3\CMS\Recordlist\Browser\DatabaseBrowser Class Reference

Inheritance diagram for TYPO3\CMS\Recordlist\Browser\DatabaseBrowser:

Public Member Functions
string	render ()
string[]	getUrlParameters (array $values)
bool	isCurrentlySelectedItem (array $values)
string	getScriptUrl ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	__construct (IconFactory $iconFactory, PageRenderer $pageRenderer, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory)
array< string, getBodyTagAttributes() { return[];} protected array< string, function getBParamDataAttributes() { $params=explode('|', $this->bparams);$fieldRef=$params[0];$rteParams=$params[1];$rteConfig=$params[2];$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\Recordlist\Browser\ElementBrowserInterface
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 ()
	initVariables ()
string	renderTableRecords ($tables)
	renderSearchBox (ElementBrowserRecordList $dblist, string $searchWord, int $searchLevels)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	determineScriptUrl ()
	setBodyTagParameters ()
	getRequest ()
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
int null	$expandPage
array	$modTSconfig = []
‪Protected Attributes inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
ModuleTemplate	$moduleTemplate
string	$thisScript = ''
string	$bparams = ''
ServerRequestInterface	$request = null
IconFactory	$iconFactory
PageRenderer	$pageRenderer
UriBuilder	$uriBuilder
ModuleTemplateFactory	$moduleTemplateFactory
array< string, function getBodyTagAttributes() { return[];} protected array< string, function getBParamDataAttributes() { $params=explode('|', $this->bparams);$fieldRef=$params[0];$rteParams=$params[1];$rteConfig=$params[2];$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 class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.

Definition at line 31 of file DatabaseBrowser.php.

Member Function Documentation

getScriptUrl()

string TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::getScriptUrl

(

)

Returns the URL of the current script

Returns

‪string

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

Definition at line 249 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\$thisScript.

getUrlParameters()

string [] TYPO3\CMS\Recordlist\Browser\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\Recordlist\Tree\View\LinkParameterProviderInterface.

Reimplemented in TYPO3\CMS\Recordlist\Browser\RecordBrowser.

Definition at line 225 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\$bparams, and TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\$expandPage.

Referenced by TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\renderTableRecords().

initialize()

TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::initialize ( )

protected

Main initialization

Reimplemented from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser.

Reimplemented in TYPO3\CMS\Recordlist\Browser\RecordBrowser.

Definition at line 42 of file DatabaseBrowser.php.

initVariables()

TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::initVariables ( )

protected

Reimplemented from TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser.

Reimplemented in TYPO3\CMS\Recordlist\Browser\RecordBrowser.

Definition at line 51 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\expandPage, and TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getRequest().

isCurrentlySelectedItem()

bool TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::isCurrentlySelectedItem

(

array

$values

)

Parameters

array

$values

‪Values to be checked

Returns

‪bool Returns TRUE if the given values match the currently selected item

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

Definition at line 239 of file DatabaseBrowser.php.

render()

string TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::render

(

)

Returns

‪string HTML content

Implements TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface.

Definition at line 78 of file DatabaseBrowser.php.

References $GLOBALS, TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\expandPage, TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getRequest(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\renderTableRecords(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\setBodyTagParameters(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

renderSearchBox()

TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::renderSearchBox ( ElementBrowserRecordList  $dblist, string  $searchWord, int  $searchLevels  )

protected

Definition at line 211 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL().

Referenced by TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\renderTableRecords().

renderTableRecords()

string TYPO3\CMS\Recordlist\Browser\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 128 of file DatabaseBrowser.php.

References $GLOBALS, TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\expandPage, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\getUrlParameters(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\renderSearchBox(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Recordlist\Browser\RecordBrowser\displayRecordsForPage(), and TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\render().

Member Data Documentation

$expandPage

int null TYPO3\CMS\Recordlist\Browser\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 39 of file DatabaseBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\getUrlParameters().

$modTSconfig

array TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::$modTSconfig = []

protected

Definition at line 40 of file DatabaseBrowser.php.

$store

TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::$store = true

Definition at line 67 of file DatabaseBrowser.php.

else

TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::else

Initial value:

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

Definition at line 68 of file DatabaseBrowser.php.

expandPage

array<int, function processSessionData($data) { if ($this->expandPage !== null) { $data['expandPage'] = $this-> TYPO3\CMS\Recordlist\Browser\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 66 of file DatabaseBrowser.php.

Referenced by TYPO3\CMS\Recordlist\Browser\RecordBrowser\displayRecordsForPage(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\initVariables(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\render(), and TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\renderTableRecords().

return

TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::return[ $data, $store]

Definition at line 72 of file DatabaseBrowser.php.