BeforeRecordDownloadIsExecutedEvent

final class \TYPO3\CMS\Backend\RecordList\Event\BeforeRecordDownloadIsExecutedEvent

Listeners to this event are able to manipulate the download of records, usually triggered via Web > List.

Table of Contents

Methods

__construct()  : mixed
getColumnsToRender()  : array
getFilename()  : string
getFormat()  : string
getHeaderRow()  : array
getId()  : int
getModTSconfig()  : array
getRecords()  : array
getRequest()  : ServerRequestInterface
getTable()  : string
isHideTranslations()  : bool
setHeaderRow()  : void
setRecords()  : void

Methods

__construct()

public __construct(array $headerRow, array $records, ServerRequestInterface $request, string $table, string $format, string $filename, int $id, array $modTSconfig, array $columnsToRender, bool $hideTranslations) : mixed

Parameters

$headerRow : array
  • Array of downloaded header metadata
$records : array
  • Array of the actual data
$request : ServerRequestInterface
  • PSR request context (for the actual download request)
$table : string
  • Name of the originating database table
$format : string
  • Format of the exported data (JSON/CSV)
$filename : string
  • Name of the exported file for download
$id : int
  • Page uid from where records are fetched
$modTSconfig : array
  • Currently applied TS config when exporting
$columnsToRender : array
  • Array of selected columns that were fetched
$hideTranslations : bool
  • Hide translations?

getColumnsToRender()

public getColumnsToRender() : array

Return values

array

getFilename()

public getFilename() : string

Return values

string

getFormat()

public getFormat() : string

Return values

string

getHeaderRow()

public getHeaderRow() : array

Return values

array

getId()

public getId() : int

Return values

int

getModTSconfig()

public getModTSconfig() : array

Return values

array

getRecords()

public getRecords() : array

Return values

array

getRequest()

public getRequest() : ServerRequestInterface

Return values

ServerRequestInterface

getTable()

public getTable() : string

Return values

string

isHideTranslations()

public isHideTranslations() : bool

Return values

bool

setHeaderRow()

public setHeaderRow(array $headerRow) : void

Parameters

$headerRow : array

setRecords()

public setRecords(array $records) : void

Parameters

$records : array
On this page