BeforeRecordDownloadIsExecutedEvent

FinalYes

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<string|int, mixed>
getFilename()  : string
getFormat()  : string
getHeaderRow()  : array<string|int, mixed>
getId()  : int
getModTSconfig()  : array<string|int, mixed>
getRecords()  : array<string|int, mixed>
getRequest()  : ServerRequestInterface
getTable()  : string
isHideTranslations()  : bool
setHeaderRow()  : void
setRecords()  : void

Methods

__construct()

public __construct(array<string|int, mixed> $headerRow, array<string|int, mixed> $records, ServerRequestInterface $request, string $table, string $format, string $filename, int $id, array<string|int, mixed> $modTSconfig, array<string|int, mixed> $columnsToRender, bool $hideTranslations) : mixed
Parameters
$headerRow : array<string|int, mixed>
  • Array of downloaded header metadata
$records : array<string|int, mixed>
  • 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<string|int, mixed>
  • Currently applied TS config when exporting
$columnsToRender : array<string|int, mixed>
  • Array of selected columns that were fetched
$hideTranslations : bool
  • Hide translations?

getColumnsToRender()

public getColumnsToRender() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFilename()

public getFilename() : string
Return values
string

getFormat()

public getFormat() : string
Return values
string

getHeaderRow()

public getHeaderRow() : array<string|int, mixed>
Return values
array<string|int, mixed>

getId()

public getId() : int
Return values
int

getModTSconfig()

public getModTSconfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRecords()

public getRecords() : array<string|int, mixed>
Return values
array<string|int, mixed>

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<string|int, mixed> $headerRow) : void
Parameters
$headerRow : array<string|int, mixed>

setRecords()

public setRecords(array<string|int, mixed> $records) : void
Parameters
$records : array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results