ColumnSelectorController

readonly class \TYPO3\CMS\Backend\Controller\ColumnSelectorController

Controller for handling the display column selection for records, typically executed from list modules.

Attributes

#[AsController]

Table of Contents

Properties

$backendViewFactory  : BackendViewFactory
$responseFactory  : ResponseFactoryInterface
$tcaSchemaFactory  : TcaSchemaFactory

Methods

__construct()  : mixed
showColumnsSelectorAction()  : ResponseInterface
Generate the show columns selector form
updateVisibleColumnsAction()  : ResponseInterface
Update the columns to be displayed for the given table
getBackendUserAuthentication()  : BackendUserAuthentication
getColumns()  : array
Retrieve all columns for the table, which can be selected
getExcludedRecordFields()  : array<int, string>
Fields, which are not relevant in the listing and are therefore not selectable. Since those fields are configurable, their names are resolved from the schema of the corresponding table.
getFileFields()  : array
Get file related fields by merging sys_file and sys_file_metadata together and adding the corresponding table as prefix (needed for labels processing).
getLanguageService()  : LanguageService
htmlResponse()  : ResponseInterface
jsonResponse()  : ResponseInterface

Properties

$responseFactory

protected ResponseFactoryInterface $responseFactory

Methods

showColumnsSelectorAction()

Generate the show columns selector form

public showColumnsSelectorAction(ServerRequestInterface $request) : ResponseInterface

Parameters

$request : ServerRequestInterface

Return values

ResponseInterface

updateVisibleColumnsAction()

Update the columns to be displayed for the given table

public updateVisibleColumnsAction(ServerRequestInterface $request) : ResponseInterface

Parameters

$request : ServerRequestInterface

Return values

ResponseInterface

getColumns()

Retrieve all columns for the table, which can be selected

protected getColumns(string $table, int $pageId) : array

Parameters

$table : string
$pageId : int

Return values

array

getExcludedRecordFields()

Fields, which are not relevant in the listing and are therefore not selectable. Since those fields are configurable, their names are resolved from the schema of the corresponding table.

protected getExcludedRecordFields(TcaSchema $schema) : array<int, string>

Parameters

$schema : TcaSchema

Return values

array<int, string>

getFileFields()

Get file related fields by merging sys_file and sys_file_metadata together and adding the corresponding table as prefix (needed for labels processing).

protected getFileFields() : array

Return values

array

jsonResponse()

protected jsonResponse(array $data) : ResponseInterface

Parameters

$data : array

Return values

ResponseInterface
On this page