RecordListController

The Content > 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
$flashMessageService  : FlashMessageService
$iconFactory  : IconFactory
$languageSelectorBuilder  : LanguageSelectorBuilder
$modTSconfig  : array<string|int, mixed>
$moduleData  : ModuleData|null
$moduleTemplateFactory  : ModuleTemplateFactory
$pageContext  : PageContext
$pageContextFactory  : PageContextFactory
$pageRenderer  : PageRenderer
$returnUrl  : string
$searchTerm  : string
$table  : string
$tcaSchemaFactory  : TcaSchemaFactory
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
mainAction()  : ResponseInterface
toggleRecordVisibilityAction()  : ResponseInterface
addNoRecordsFlashMessage()  : mixed
buildListUrl()  : string
Build list URL preserving relevant parameters (search, table, sort).
createLanguageSelector()  : void
Creates the language selector dropdown in the module toolbar.
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
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 = []

$returnUrl

protected string $returnUrl = ''

$searchTerm

protected string $searchTerm = ''

Methods

__construct()

public __construct(ComponentFactory $componentFactory, IconFactory $iconFactory, PageRenderer $pageRenderer, EventDispatcherInterface $eventDispatcher, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory, TcaSchemaFactory $tcaSchemaFactory, FlashMessageService $flashMessageService, PageContextFactory $pageContextFactory, LanguageSelectorBuilder $languageSelectorBuilder) : mixed
Parameters
$componentFactory : ComponentFactory
$iconFactory : IconFactory
$pageRenderer : PageRenderer
$eventDispatcher : EventDispatcherInterface
$uriBuilder : UriBuilder
$moduleTemplateFactory : ModuleTemplateFactory
$tcaSchemaFactory : TcaSchemaFactory
$flashMessageService : FlashMessageService
$pageContextFactory : PageContextFactory
$languageSelectorBuilder : LanguageSelectorBuilder

mainAction()

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

toggleRecordVisibilityAction()

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

buildListUrl()

Build list URL preserving relevant parameters (search, table, sort).

protected buildListUrl(ServerRequestInterface $request[, array<string|int, mixed> $additionalParams = [] ]) : string

Does NOT preserve pagination (pointer) to allow resetting to first page.

Parameters
$request : ServerRequestInterface
$additionalParams : array<string|int, mixed> = []

Additional parameters to add/override (e.g., ['languages' => [0, 1]])

Return values
string

createLanguageSelector()

Creates the language selector dropdown in the module toolbar.

protected createLanguageSelector(ModuleTemplate $view, ServerRequestInterface $request) : void
Parameters
$view : ModuleTemplate
$request : ServerRequestInterface

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, UriInterface $listUrl, array<string|int, mixed> $moduleSettings) : void
Parameters
$view : ModuleTemplate
$clipboard : Clipboard
$request : ServerRequestInterface
$table : string
$listUrl : UriInterface
$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

renderPageTranslations()

protected renderPageTranslations(DatabaseRecordList $dbList, array<string|int, mixed> $siteLanguages) : string
Parameters
$dbList : DatabaseRecordList
$siteLanguages : array<string|int, mixed>
Return values
string

renderSearchBox()

protected renderSearchBox(ServerRequestInterface $request, DatabaseRecordList $dbList, string $searchWord, int $searchLevels) : string
Parameters
$request : ServerRequestInterface
$dbList : DatabaseRecordList
$searchWord : string
$searchLevels : int
Return values
string

showPageTranslations()

protected showPageTranslations() : bool
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results