RecordListController

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

Internal

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

Attributes
#[AsController]

Table of Contents

Properties

$allowClipboard  : bool
$allowSearch  : bool
$eventDispatcher  : EventDispatcherInterface
$iconFactory  : IconFactory
$id  : int
$modTSconfig  : array<string|int, mixed>
$moduleData  : ModuleData|null
$moduleTemplateFactory  : ModuleTemplateFactory
$pageInfo  : array<string|int, mixed>
$pagePermissions  : Permission
$pageRenderer  : PageRenderer
$returnUrl  : string
$searchTerm  : string
$table  : string
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
mainAction()  : ResponseInterface
addNoRecordsFlashMessage()  : mixed
canCreatePreviewLink()  : bool
Returns the configuration of mod.web_list.noViewWithDokTypes or the default value 254 (Sys Folders), if not set.
createModuleUri()  : string
deleteRecords()  : void
editLockPermissions()  : bool
Check whether the current backend user is an admin or the current page is locked by edit lock.
getBackendUserAuthentication()  : BackendUserAuthentication
getDocHeaderButtons()  : void
Create the panel of buttons for submitting the form or otherwise perform operations.
getLanguageService()  : LanguageService
getShortcutTitle()  : string
Returns the shortcut title for the current page.
initializeClipboard()  : Clipboard
Process incoming data and configure the clipboard.
isPageEditable()  : bool
Check if page can be edited by current user
languageSelector()  : string
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.
renderPageTranslations()  : string
renderSearchBox()  : string
showPageTranslations()  : bool

Properties

$allowClipboard

protected bool $allowClipboard = true

$allowSearch

protected bool $allowSearch = true

$eventDispatcher read-only

protected EventDispatcherInterface $eventDispatcher

$modTSconfig

protected array<string|int, mixed> $modTSconfig = []

$pageInfo

protected array<string|int, mixed> $pageInfo = []

$returnUrl

protected string $returnUrl = ''

$searchTerm

protected string $searchTerm = ''

Methods

mainAction()

public mainAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

canCreatePreviewLink()

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

protected canCreatePreviewLink() : bool
Return values
bool

createModuleUri()

protected createModuleUri(ServerRequestInterface $request[, array<string|int, mixed> $params = [] ]) : string
Parameters
$request : ServerRequestInterface
$params : array<string|int, mixed> = []
Return values
string

deleteRecords()

protected deleteRecords(ServerRequestInterface $request, Clipboard $clipboard) : void
Parameters
$request : ServerRequestInterface
$clipboard : Clipboard

editLockPermissions()

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

protected editLockPermissions() : bool
Return values
bool

getDocHeaderButtons()

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

protected getDocHeaderButtons(ModuleTemplate $view, Clipboard $clipboard, ServerRequestInterface $request, string $table, string $listUrl, array<string|int, mixed> $moduleSettings) : void
Parameters
$view : ModuleTemplate
$clipboard : Clipboard
$request : ServerRequestInterface
$table : string
$listUrl : string
$moduleSettings : array<string|int, mixed>

getShortcutTitle()

Returns the shortcut title for the current page.

protected getShortcutTitle(array<string|int, mixed> $arguments) : string
Parameters
$arguments : array<string|int, mixed>
Return values
string

initializeClipboard()

Process incoming data and configure the clipboard.

protected initializeClipboard(ServerRequestInterface $request, bool $isClipboardShown) : Clipboard
Parameters
$request : ServerRequestInterface
$isClipboardShown : bool
Return values
Clipboard

isPageEditable()

Check if page can be edited by current user

protected isPageEditable() : bool
Return values
bool

languageSelector()

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.

protected languageSelector(array<string|int, mixed> $siteLanguages, string $requestUri) : string
Parameters
$siteLanguages : array<string|int, mixed>
$requestUri : string
Tags
throws
RouteNotFoundException
Return values
string —

HTML