TYPO3\CMS\Recordlist\Browser\DatabaseBrowser Class Reference

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

Public Member Functions
array[]	processSessionData ($data)
string	render ()
string[]	getUrlParameters (array $values)
bool	isCurrentlySelectedItem (array $values)
string	getScriptUrl ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	__construct ()

Protected Member Functions
	initialize ()
	initVariables ()
string	getTemporaryTreeMountCancelNotice ()
	setTemporaryDbMounts ()
string	renderTableRecords ($tables)
string[]	getBodyTagAttributes ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
	determineScriptUrl ()
	setBodyTagParameters ()
array< string, getBodyTagAttributes();protected array< string, function getBParamDataAttributes() {[ $fieldRef, $rteParams, $rteConfig,, $irreObjectId]=explode('|', $this->bparams);return['data-this-script-url'=> strpos( $this->thisScript, '?')===false ? $this-> LanguageService function	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
int null	$expandPage
‪Protected Attributes inherited from ‪TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser
ModuleTemplate	$moduleTemplate
PageRenderer	$pageRenderer
string	$thisScript = ''
IconFactory	$iconFactory
string	$bparams
array< string, function getBodyTagAttributes();protected array< string, function getBParamDataAttributes() {[ $fieldRef, $rteParams, $rteConfig,, $irreObjectId]=explode('|', $this->bparams);return['data-this-script-url'=> strpos( $this->thisScript, '?')===false ? $this->	thisScript: $this->thisScript . '&'

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

getBodyTagAttributes()

string [] TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::getBodyTagAttributes ( )

protected

Returns

‪string[] Array of body-tag attributes

Definition at line 248 of file DatabaseBrowser.php.

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 283 of file DatabaseBrowser.php.

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

getTemporaryTreeMountCancelNotice()

string TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::getTemporaryTreeMountCancelNotice ( )

protected

Check if a temporary tree mount is set and return a cancel link

Returns

‪string URL

Definition at line 128 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser().

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

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 259 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 41 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 47 of file DatabaseBrowser.php.

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 273 of file DatabaseBrowser.php.

processSessionData()

array [] TYPO3\CMS\Recordlist\Browser\DatabaseBrowser::processSessionData

(

$data

)

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

Parameters

mixed[]

$data

‪Session data array

Returns

‪array[] Session data and boolean which indicates that data needs to be stored in session because it's changed

Implements TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface.

Definition at line 59 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\$expandPage.

render()

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

(

)

Returns

‪string HTML content

Implements TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface.

Definition at line 74 of file DatabaseBrowser.php.

References $GLOBALS, TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getLanguageService(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\getTemporaryTreeMountCancelNotice(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\renderTableRecords(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\setBodyTagParameters(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\setTemporaryDbMounts(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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 158 of file DatabaseBrowser.php.

References $GLOBALS, TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\$thisScript, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\getUrlParameters(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, TYPO3\CMS\Backend\Utility\BackendUtility\readPageAccess(), 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().

setTemporaryDbMounts()

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

protected

If the current Backend User has set a temporary DB mount, it is stored to her/his UC.

Definition at line 139 of file DatabaseBrowser.php.

References TYPO3\CMS\Recordlist\Browser\AbstractElementBrowser\getBackendUser().

Referenced by 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(), and TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\processSessionData().