ColumnSelectorController
Read onlyYes
Controller for handling the display column selection for records, typically executed from list modules.
This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
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<string|int, mixed>
- 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<string|int, mixed>
- 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
$backendViewFactory
protected
BackendViewFactory
$backendViewFactory
$responseFactory
protected
ResponseFactoryInterface
$responseFactory
$tcaSchemaFactory
protected
TcaSchemaFactory
$tcaSchemaFactory
Methods
__construct()
public
__construct(ResponseFactoryInterface $responseFactory, BackendViewFactory $backendViewFactory, TcaSchemaFactory $tcaSchemaFactory) : mixed
Parameters
- $responseFactory : ResponseFactoryInterface
- $backendViewFactory : BackendViewFactory
- $tcaSchemaFactory : TcaSchemaFactory
showColumnsSelectorAction()
Generate the show columns selector form
public
showColumnsSelectorAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfaceupdateVisibleColumnsAction()
Update the columns to be displayed for the given table
public
updateVisibleColumnsAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfacegetBackendUserAuthentication()
protected
getBackendUserAuthentication() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetColumns()
Retrieve all columns for the table, which can be selected
protected
getColumns(string $table, int $pageId) : array<string|int, mixed>
Parameters
- $table : string
- $pageId : int
Return values
array<string|int, mixed>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<string|int, mixed>
Return values
array<string|int, mixed>getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicehtmlResponse()
protected
htmlResponse(ViewInterface $view) : ResponseInterface
Parameters
- $view : ViewInterface
Return values
ResponseInterfacejsonResponse()
protected
jsonResponse(array<string|int, mixed> $data) : ResponseInterface
Parameters
- $data : array<string|int, mixed>