TYPO3\CMS\Backend\Controller\RecordListController Class Reference

Public Member Functions
	__construct (protected readonly IconFactory $iconFactory, protected readonly PageRenderer $pageRenderer, protected readonly EventDispatcherInterface $eventDispatcher, protected readonly UriBuilder $uriBuilder, protected readonly ModuleTemplateFactory $moduleTemplateFactory,)
	mainAction (ServerRequestInterface $request)

Protected Member Functions
	initializeClipboard (ServerRequestInterface $request, bool $isClipboardShown)
	deleteRecords (ServerRequestInterface $request, Clipboard $clipboard)
	renderSearchBox (ServerRequestInterface $request, DatabaseRecordList $dbList, string $searchWord, int $searchLevels)
	getDocHeaderButtons (ModuleTemplate $view, Clipboard $clipboard, ServerRequestInterface $request, string $table, string $listUrl, array $moduleSettings)
	addNoRecordsFlashMessage (ModuleTemplate $view, string $table)
string	languageSelector (array $siteLanguages, string $requestUri)
	canCreatePreviewLink ()
	editLockPermissions ()
	getShortcutTitle (array $arguments)
	showPageTranslations ()
	renderPageTranslations (DatabaseRecordList $dbList, array $siteLanguages)
	createModuleUri (ServerRequestInterface $request, array $params=[])
	isPageEditable ()
	getBackendUserAuthentication ()
	getLanguageService ()

Protected Attributes
Permission	$pagePermissions
int	$id = 0
string	$table = ''
string	$searchTerm = ''
array	$pageInfo = []
string	$returnUrl = ''
array	$modTSconfig = []
ModuleData	$moduleData = null
bool	$allowClipboard = true
bool	$allowSearch = true

Detailed Description

The Web > List module: Rendering the listing of records on a page.

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

Definition at line 61 of file RecordListController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Controller\RecordListController::__construct	(	protected readonly IconFactory	$iconFactory,
		protected readonly PageRenderer	$pageRenderer,
		protected readonly EventDispatcherInterface	$eventDispatcher,
		protected readonly UriBuilder	$uriBuilder,
		protected readonly ModuleTemplateFactory	$moduleTemplateFactory
	)

Definition at line 77 of file RecordListController.php.

Member Function Documentation

addNoRecordsFlashMessage()

TYPO3\CMS\Backend\Controller\RecordListController::addNoRecordsFlashMessage ( ModuleTemplate  $view, string  $table  )

protected

Definition at line 451 of file RecordListController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\RecordListController\$table, TYPO3\CMS\Backend\Template\ModuleTemplate\addFlashMessage(), and TYPO3\CMS\Backend\Controller\RecordListController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

canCreatePreviewLink()

TYPO3\CMS\Backend\Controller\RecordListController::canCreatePreviewLink ( )

protected

Returns the configuration of mod.web_list.noViewWithDokTypes or the default value 254 (Sys Folders), if not set.

Definition at line 536 of file RecordListController.php.

References TYPO3\CMS\Core\Domain\Repository\PageRepository\DOKTYPE_SYSFOLDER, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons().

createModuleUri()

TYPO3\CMS\Backend\Controller\RecordListController::createModuleUri ( ServerRequestInterface  $request, array  $params = []  )

protected

Definition at line 606 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons().

deleteRecords()

TYPO3\CMS\Backend\Controller\RecordListController::deleteRecords ( ServerRequestInterface  $request, Clipboard  $clipboard  )

protected

Definition at line 252 of file RecordListController.php.

References TYPO3\CMS\Backend\Clipboard\Clipboard\cleanUpCBC().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

editLockPermissions()

TYPO3\CMS\Backend\Controller\RecordListController::editLockPermissions ( )

protected

Check whether the current backend user is an admin or the current page is locked by edit lock.

Definition at line 551 of file RecordListController.php.

References TYPO3\CMS\Backend\Controller\RecordListController\getBackendUserAuthentication().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), and TYPO3\CMS\Backend\Controller\RecordListController\isPageEditable().

getBackendUserAuthentication()

TYPO3\CMS\Backend\Controller\RecordListController::getBackendUserAuthentication ( )

protected

Definition at line 644 of file RecordListController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\editLockPermissions(), TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), TYPO3\CMS\Backend\Controller\RecordListController\isPageEditable(), TYPO3\CMS\Backend\Controller\RecordListController\languageSelector(), TYPO3\CMS\Backend\Controller\RecordListController\mainAction(), and TYPO3\CMS\Backend\Controller\RecordListController\showPageTranslations().

getDocHeaderButtons()

TYPO3\CMS\Backend\Controller\RecordListController::getDocHeaderButtons ( ModuleTemplate  $view, Clipboard  $clipboard, ServerRequestInterface  $request, string  $table, string  $listUrl, array  $moduleSettings  )

protected

Create the panel of buttons for submitting the form or otherwise perform operations.

Definition at line 288 of file RecordListController.php.

References TYPO3\CMS\Backend\Controller\RecordListController\$id, TYPO3\CMS\Backend\Controller\RecordListController\$table, TYPO3\CMS\Webhooks\Message\$url, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Backend\Controller\RecordListController\canCreatePreviewLink(), TYPO3\CMS\Backend\Clipboard\Clipboard\confirmMsgText(), TYPO3\CMS\Backend\Routing\PreviewUriBuilder\create(), TYPO3\CMS\Backend\Controller\RecordListController\createModuleUri(), TYPO3\CMS\Backend\Controller\RecordListController\editLockPermissions(), TYPO3\CMS\Backend\Clipboard\Clipboard\elFromTable(), TYPO3\CMS\Backend\Controller\RecordListController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Template\ModuleTemplate\getDocHeaderComponent(), TYPO3\CMS\Backend\Controller\RecordListController\getLanguageService(), TYPO3\CMS\Backend\Controller\RecordListController\getShortcutTitle(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Backend\Controller\RecordListController\isPageEditable(), and TYPO3\CMS\Backend\Clipboard\Clipboard\pasteUrl().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

getLanguageService()

TYPO3\CMS\Backend\Controller\RecordListController::getLanguageService ( )

protected

Definition at line 649 of file RecordListController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\addNoRecordsFlashMessage(), TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), TYPO3\CMS\Backend\Controller\RecordListController\getShortcutTitle(), TYPO3\CMS\Backend\Controller\RecordListController\languageSelector(), and TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

getShortcutTitle()

TYPO3\CMS\Backend\Controller\RecordListController::getShortcutTitle ( array  $arguments )

protected

Returns the shortcut title for the current page.

Definition at line 559 of file RecordListController.php.

References $GLOBALS, and TYPO3\CMS\Backend\Controller\RecordListController\getLanguageService().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons().

initializeClipboard()

TYPO3\CMS\Backend\Controller\RecordListController::initializeClipboard ( ServerRequestInterface  $request, bool  $isClipboardShown  )

protected

Process incoming data and configure the clipboard.

Definition at line 224 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

isPageEditable()

TYPO3\CMS\Backend\Controller\RecordListController::isPageEditable ( )

protected

Check if page can be edited by current user

Definition at line 624 of file RecordListController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\RecordListController\editLockPermissions(), and TYPO3\CMS\Backend\Controller\RecordListController\getBackendUserAuthentication().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), and TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

languageSelector()

string TYPO3\CMS\Backend\Controller\RecordListController::languageSelector ( array  $siteLanguages, string  $requestUri  )

protected

Make selector box for creating new translation in a language Displays only languages which are not yet present for the current page and that are not disabled with page TS.

Returns

‪string HTML <select> element (if there were items for the box anyways...)

Exceptions

RouteNotFoundException

Definition at line 470 of file RecordListController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\RecordListController\$id, $output, TYPO3\CMS\Redirects\Message\$targetUrl, TYPO3\CMS\Backend\Controller\RecordListController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Controller\RecordListController\getLanguageService(), and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

mainAction()

TYPO3\CMS\Backend\Controller\RecordListController::mainAction

(

ServerRequestInterface

$request

)

Definition at line 85 of file RecordListController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\RecordListController\$id, TYPO3\CMS\Backend\Controller\RecordListController\$modTSconfig, TYPO3\CMS\Backend\Controller\RecordListController\$pageInfo, TYPO3\CMS\Backend\Controller\RecordListController\$pagePermissions, TYPO3\CMS\Backend\Controller\RecordListController\$returnUrl, TYPO3\CMS\Backend\Controller\RecordListController\addNoRecordsFlashMessage(), TYPO3\CMS\Backend\Controller\RecordListController\deleteRecords(), TYPO3\CMS\Backend\Controller\RecordListController\getBackendUserAuthentication(), TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), TYPO3\CMS\Backend\Controller\RecordListController\getLanguageService(), TYPO3\CMS\Backend\Controller\RecordListController\initializeClipboard(), TYPO3\CMS\Backend\Controller\RecordListController\isPageEditable(), TYPO3\CMS\Backend\Controller\RecordListController\languageSelector(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, TYPO3\CMS\Backend\Controller\RecordListController\renderPageTranslations(), TYPO3\CMS\Backend\Controller\RecordListController\renderSearchBox(), TYPO3\CMS\Backend\Controller\RecordListController\showPageTranslations(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

renderPageTranslations()

TYPO3\CMS\Backend\Controller\RecordListController::renderPageTranslations ( DatabaseRecordList  $dbList, array  $siteLanguages  )

protected

Definition at line 593 of file RecordListController.php.

References TYPO3\CMS\Backend\Controller\RecordListController\$id.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

renderSearchBox()

TYPO3\CMS\Backend\Controller\RecordListController::renderSearchBox ( ServerRequestInterface  $request, DatabaseRecordList  $dbList, string  $searchWord, int  $searchLevels  )

protected

Definition at line 275 of file RecordListController.php.

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

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

showPageTranslations()

TYPO3\CMS\Backend\Controller\RecordListController::showPageTranslations ( )

protected

Definition at line 579 of file RecordListController.php.

References $GLOBALS, TYPO3\CMS\Backend\Controller\RecordListController\getBackendUserAuthentication(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

Member Data Documentation

$allowClipboard

bool TYPO3\CMS\Backend\Controller\RecordListController::$allowClipboard = true

protected

Definition at line 74 of file RecordListController.php.

$allowSearch

bool TYPO3\CMS\Backend\Controller\RecordListController::$allowSearch = true

protected

Definition at line 75 of file RecordListController.php.

$id

int TYPO3\CMS\Backend\Controller\RecordListController::$id = 0

protected

Definition at line 67 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), TYPO3\CMS\Backend\Controller\RecordListController\languageSelector(), TYPO3\CMS\Backend\Controller\RecordListController\mainAction(), and TYPO3\CMS\Backend\Controller\RecordListController\renderPageTranslations().

$modTSconfig

array TYPO3\CMS\Backend\Controller\RecordListController::$modTSconfig = []

protected

Definition at line 72 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

$moduleData

ModuleData TYPO3\CMS\Backend\Controller\RecordListController::$moduleData = null

protected

Definition at line 73 of file RecordListController.php.

$pageInfo

array TYPO3\CMS\Backend\Controller\RecordListController::$pageInfo = []

protected

Definition at line 70 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

$pagePermissions

Permission TYPO3\CMS\Backend\Controller\RecordListController::$pagePermissions

protected

Definition at line 65 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

$returnUrl

string TYPO3\CMS\Backend\Controller\RecordListController::$returnUrl = ''

protected

Definition at line 71 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\mainAction().

$searchTerm

string TYPO3\CMS\Backend\Controller\RecordListController::$searchTerm = ''

protected

Definition at line 69 of file RecordListController.php.

$table

string TYPO3\CMS\Backend\Controller\RecordListController::$table = ''

protected

Definition at line 68 of file RecordListController.php.

Referenced by TYPO3\CMS\Backend\Controller\RecordListController\addNoRecordsFlashMessage(), and TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons().