Public Member Functions
	__construct (IconFactory $iconFactory, PageRenderer $pageRenderer, EventDispatcherInterface $eventDispatcher, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory, ResponseFactoryInterface $responseFactory)

ResponseInterface	mainAction (ServerRequestInterface $request)

Protected Member Functions
Clipboard	initializeClipboard (ServerRequestInterface $request, bool $isClipboardShown)

	renderSearchBox (DatabaseRecordList $dblist, string $searchWord, int $searchLevels)

	getDocHeaderButtons (Clipboard $clipboard, array $queryParams, string $table, string $listUrl, array $moduleSettings)

string	languageSelector (string $requestUri)

	canCreatePreviewLink ()

bool	editLockPermissions ()

string	getShortcutTitle (array $arguments)

	showPageTranslations ()

	htmlResponse (string $html)

BackendUserAuthentication	getBackendUserAuthentication ()

LanguageService	getLanguageService ()

bool	isPageEditable ()

Protected Attributes
ModuleTemplate	$moduleTemplate

SiteLanguage[]	$siteLanguages = array( )

Permission	$pagePermissions

int	$id = 0

array	$pageInfo = []

string	$returnUrl = ''

array	$modTSconfig = []

IconFactory	$iconFactory

PageRenderer	$pageRenderer

EventDispatcherInterface	$eventDispatcher

UriBuilder	$uriBuilder

ModuleTemplateFactory	$moduleTemplateFactory

ResponseFactoryInterface	$responseFactory

Detailed Description

Script Class for 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 57 of file RecordListController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Recordlist\Controller\RecordListController::__construct	(	IconFactory	$iconFactory,
		PageRenderer	$pageRenderer,
		EventDispatcherInterface	$eventDispatcher,
		UriBuilder	$uriBuilder,
		ModuleTemplateFactory	$moduleTemplateFactory,
		ResponseFactoryInterface	$responseFactory
	)

Definition at line 85 of file RecordListController.php.

References TYPO3\CMS\Recordlist\Controller\RecordListController\$eventDispatcher, TYPO3\CMS\Recordlist\Controller\RecordListController\$iconFactory, TYPO3\CMS\Recordlist\Controller\RecordListController\$moduleTemplateFactory, TYPO3\CMS\Recordlist\Controller\RecordListController\$pageRenderer, TYPO3\CMS\Recordlist\Controller\RecordListController\$responseFactory, and TYPO3\CMS\Recordlist\Controller\RecordListController\$uriBuilder.

Member Function Documentation

◆ canCreatePreviewLink()

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

protected

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

Definition at line 626 of file RecordListController.php.

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

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

◆ editLockPermissions()

bool TYPO3\CMS\Recordlist\Controller\RecordListController::editLockPermissions ( )

protected

Check whether or not the current backend user is an admin or the current page is locked by editlock.

Returns: ‪bool

Definition at line 646 of file RecordListController.php.

References TYPO3\CMS\Recordlist\Controller\RecordListController\getBackendUserAuthentication(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin().

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

◆ getBackendUserAuthentication()

BackendUserAuthentication TYPO3\CMS\Recordlist\Controller\RecordListController::getBackendUserAuthentication ( )

protected

Returns: ‪BackendUserAuthentication

Definition at line 707 of file RecordListController.php.

References $GLOBALS.

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

◆ getDocHeaderButtons()

TYPO3\CMS\Recordlist\Controller\RecordListController::getDocHeaderButtons	(	Clipboard	$clipboard,
		array	$queryParams,
		string	$table,
		string	$listUrl,
		array	$moduleSettings
	)

protected

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

Parameters

Clipboard	$clipboard
array	$queryParams
string	$table
string	$listUrl
array	$moduleSettings

Definition at line 414 of file RecordListController.php.

References TYPO3\CMS\Recordlist\Controller\RecordListController\$id, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Recordlist\Controller\RecordListController\canCreatePreviewLink(), TYPO3\CMS\Backend\Clipboard\Clipboard\confirmMsgText(), TYPO3\CMS\Backend\Routing\PreviewUriBuilder\create(), TYPO3\CMS\Recordlist\Controller\RecordListController\editLockPermissions(), TYPO3\CMS\Backend\Clipboard\Clipboard\elFromTable(), TYPO3\CMS\Recordlist\Controller\RecordListController\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\Controller\RecordListController\getLanguageService(), TYPO3\CMS\Recordlist\Controller\RecordListController\getShortcutTitle(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Recordlist\Controller\RecordListController\isPageEditable(), TYPO3\CMS\Backend\Clipboard\Clipboard\pasteUrl(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ getLanguageService()

LanguageService TYPO3\CMS\Recordlist\Controller\RecordListController::getLanguageService ( )

protected

Returns: ‪LanguageService

Definition at line 715 of file RecordListController.php.

References $GLOBALS.

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

◆ getShortcutTitle()

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

protected

Returns the shortcut title for the current page

Parameters

array $arguments

Returns: ‪string

Definition at line 657 of file RecordListController.php.

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

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

◆ htmlResponse()

TYPO3\CMS\Recordlist\Controller\RecordListController::htmlResponse ( string $html )

protected

Definition at line 696 of file RecordListController.php.

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

◆ initializeClipboard()

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

protected

Processing incoming data and configures the clipboard.

Parameters

ServerRequestInterface	$request
bool	$isClipboardShown

Returns: ‪Clipboard

Definition at line 351 of file RecordListController.php.

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

◆ isPageEditable()

bool TYPO3\CMS\Recordlist\Controller\RecordListController::isPageEditable ( )

protected

Check if page can be edited by current user

Returns: ‪bool

Definition at line 725 of file RecordListController.php.

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

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

◆ languageSelector()

string TYPO3\CMS\Recordlist\Controller\RecordListController::languageSelector ( 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.

Parameters

string $requestUri

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

Exceptions

Definition at line 564 of file RecordListController.php.

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

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

◆ mainAction()

ResponseInterface TYPO3\CMS\Recordlist\Controller\RecordListController::mainAction ( ServerRequestInterface $request )

Injects the request object for the current request or subrequest

Parameters

ServerRequestInterface $request ‪the current request

Returns: ‪ResponseInterface the response with the content

Definition at line 107 of file RecordListController.php.

◆ renderSearchBox()

TYPO3\CMS\Recordlist\Controller\RecordListController::renderSearchBox	(	DatabaseRecordList	$dblist,
		string	$searchWord,
		int	$searchLevels
	)

protected

Definition at line 380 of file RecordListController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Recordlist\Controller\RecordListController\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ showPageTranslations()

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

protected

Definition at line 680 of file RecordListController.php.

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

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

Member Data Documentation

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Recordlist\Controller\RecordListController::$eventDispatcher

protected

Definition at line 80 of file RecordListController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\RecordListController\__construct().

◆ $iconFactory

IconFactory TYPO3\CMS\Recordlist\Controller\RecordListController::$iconFactory

protected

Definition at line 78 of file RecordListController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\RecordListController\__construct().

◆ $id

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

protected

Definition at line 73 of file RecordListController.php.

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

◆ $modTSconfig

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

protected

Definition at line 76 of file RecordListController.php.

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

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Recordlist\Controller\RecordListController::$moduleTemplate

protected

ModuleTemplate object

Definition at line 63 of file RecordListController.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Recordlist\Controller\RecordListController::$moduleTemplateFactory

protected

Definition at line 82 of file RecordListController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\RecordListController\__construct().

◆ $pageInfo

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

protected

Definition at line 74 of file RecordListController.php.

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

◆ $pagePermissions

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

protected

Definition at line 71 of file RecordListController.php.

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

◆ $pageRenderer

PageRenderer TYPO3\CMS\Recordlist\Controller\RecordListController::$pageRenderer

protected

Definition at line 79 of file RecordListController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\RecordListController\__construct().

◆ $responseFactory

ResponseFactoryInterface TYPO3\CMS\Recordlist\Controller\RecordListController::$responseFactory

protected

Definition at line 83 of file RecordListController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\RecordListController\__construct().

◆ $returnUrl

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

protected

Definition at line 75 of file RecordListController.php.

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

◆ $siteLanguages

SiteLanguage [] TYPO3\CMS\Recordlist\Controller\RecordListController::$siteLanguages = array( )

protected

Definition at line 67 of file RecordListController.php.

◆ $uriBuilder

UriBuilder TYPO3\CMS\Recordlist\Controller\RecordListController::$uriBuilder

protected

Definition at line 81 of file RecordListController.php.

Referenced by TYPO3\CMS\Recordlist\Controller\RecordListController\__construct().

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canCreatePreviewLink()

◆ editLockPermissions()

◆ getBackendUserAuthentication()

◆ getDocHeaderButtons()

◆ getLanguageService()

◆ getShortcutTitle()

◆ htmlResponse()

◆ initializeClipboard()

◆ isPageEditable()

◆ languageSelector()

◆ mainAction()

◆ renderSearchBox()

◆ showPageTranslations()

Member Data Documentation

◆ $eventDispatcher

◆ $iconFactory

◆ $id

◆ $modTSconfig

◆ $moduleTemplate

◆ $moduleTemplateFactory

◆ $pageInfo

◆ $pagePermissions

◆ $pageRenderer

◆ $responseFactory

◆ $returnUrl

◆ $siteLanguages

◆ $uriBuilder