RecordListController extends RecordListController
The Web > List module: Rendering the listing of records on a page.
since TYPO3 v12, will be removed in TYPO3 v13
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) and 255 (Recycler), 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
$iconFactory read-only
protected
IconFactory
$iconFactory
$id
protected
int
$id
= 0
$modTSconfig
protected
array<string|int, mixed>
$modTSconfig
= []
$moduleData
protected
ModuleData|null
$moduleData
= null
$moduleTemplateFactory read-only
protected
ModuleTemplateFactory
$moduleTemplateFactory
$pageInfo
protected
array<string|int, mixed>
$pageInfo
= []
$pagePermissions
protected
Permission
$pagePermissions
$pageRenderer read-only
protected
PageRenderer
$pageRenderer
$returnUrl
protected
string
$returnUrl
= ''
$searchTerm
protected
string
$searchTerm
= ''
$table
protected
string
$table
= ''
$uriBuilder read-only
protected
UriBuilder
$uriBuilder
Methods
__construct()
public
__construct(IconFactory $iconFactory, PageRenderer $pageRenderer, EventDispatcherInterface $eventDispatcher, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory) : mixed
Parameters
- $iconFactory : IconFactory
- $pageRenderer : PageRenderer
- $eventDispatcher : EventDispatcherInterface
- $uriBuilder : UriBuilder
- $moduleTemplateFactory : ModuleTemplateFactory
mainAction()
public
mainAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfaceaddNoRecordsFlashMessage()
protected
addNoRecordsFlashMessage(ModuleTemplate $view, string $table) : mixed
Parameters
- $view : ModuleTemplate
- $table : string
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
boolcreateModuleUri()
protected
createModuleUri(ServerRequestInterface $request[, array<string|int, mixed> $params = [] ]) : string
Parameters
- $request : ServerRequestInterface
- $params : array<string|int, mixed> = []
Return values
stringdeleteRecords()
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
boolgetBackendUserAuthentication()
protected
getBackendUserAuthentication() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetDocHeaderButtons()
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>
getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetShortcutTitle()
Returns the shortcut title for the current page.
protected
getShortcutTitle(array<string|int, mixed> $arguments) : string
Parameters
- $arguments : array<string|int, mixed>
Return values
stringinitializeClipboard()
Process incoming data and configure the clipboard.
protected
initializeClipboard(ServerRequestInterface $request, bool $isClipboardShown) : Clipboard
Parameters
- $request : ServerRequestInterface
- $isClipboardShown : bool
Return values
ClipboardisPageEditable()
Check if page can be edited by current user
protected
isPageEditable() : bool
Return values
boollanguageSelector()
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
Return values
string —HTML
renderPageTranslations()
protected
renderPageTranslations(DatabaseRecordList $dbList, array<string|int, mixed> $siteLanguages) : string
Parameters
- $dbList : DatabaseRecordList
- $siteLanguages : array<string|int, mixed>
Return values
stringrenderSearchBox()
protected
renderSearchBox(ServerRequestInterface $request, DatabaseRecordList $dbList, string $searchWord, int $searchLevels) : string
Parameters
- $request : ServerRequestInterface
- $dbList : DatabaseRecordList
- $searchWord : string
- $searchLevels : int
Return values
stringshowPageTranslations()
protected
showPageTranslations() : bool