RecordListController

Script Class for 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.

Table of Contents

Properties

$eventDispatcher  : EventDispatcherInterface
$iconFactory  : IconFactory
$id  : int
$modTSconfig  : array<string|int, mixed>
$moduleTemplate  : ModuleTemplate
ModuleTemplate object
$moduleTemplateFactory  : ModuleTemplateFactory
$pageInfo  : array<string|int, mixed>
$pagePermissions  : Permission
$pageRenderer  : PageRenderer
$responseFactory  : ResponseFactoryInterface
$returnUrl  : string
$siteLanguages  : array<string|int, SiteLanguage>
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
mainAction()  : ResponseInterface
Injects the request object for the current request or subrequest
canCreatePreviewLink()  : bool
Returns the configuration of mod.web_list.noViewWithDokTypes or the default value 254 (Sys Folders) and 255 (Recycler), if not set.
editLockPermissions()  : bool
Check whether or not the current backend user is an admin or the current page is locked by editlock.
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
htmlResponse()  : ResponseInterface
initializeClipboard()  : Clipboard
Processing incoming data and configures 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.
renderSearchBox()  : string
showPageTranslations()  : bool

Properties

$eventDispatcher

protected EventDispatcherInterface $eventDispatcher

$modTSconfig

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

$pageInfo

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

$responseFactory

protected ResponseFactoryInterface $responseFactory

$returnUrl

protected string $returnUrl = ''

Methods

mainAction()

Injects the request object for the current request or subrequest

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

the current request

Return values
ResponseInterface —

the response with the content

canCreatePreviewLink()

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

protected canCreatePreviewLink() : bool
Return values
bool

editLockPermissions()

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

protected editLockPermissions() : bool
Return values
bool

getDocHeaderButtons()

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

protected getDocHeaderButtons(Clipboard $clipboard, array<string|int, mixed> $queryParams, string $table, string $listUrl, array<string|int, mixed> $moduleSettings) : void
Parameters
$clipboard : Clipboard
$queryParams : array<string|int, mixed>
$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

htmlResponse()

protected htmlResponse(string $html) : ResponseInterface
Parameters
$html : string
Return values
ResponseInterface

initializeClipboard()

Processing incoming data and configures 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(string $requestUri) : string
Parameters
$requestUri : string
Tags
throws
RouteNotFoundException
Return values
string —

HTML