BeforeRecordDownloadPresetsAreDisplayedEvent

FinalYes

Event to manipulate the available list of download presets.

Array $presets contains a list of DownloadPreset objects with their methods: getIdentifier(), getLabel() and getColumns().

The event is always coupled to a specific database table.

Table of Contents

Methods

__construct()  : mixed
getDatabaseTable()  : string
getId()  : int
getPresets()  : array<string|int, DownloadPreset>
getRequest()  : ServerRequestInterface
setPresets()  : void

Methods

__construct()

public __construct(string $table, array<string|int, array{columns: string|string[]|null, label: string|null}> $presets, ServerRequestInterface $request, int $id) : mixed
Parameters
$table : string
  • Name of the originating database table
$presets : array<string|int, array{columns: string|string[]|null, label: string|null}>
  • Contains list of sub-arrays with keys "label" (string, name of the preset) and "columns" (string, comma-separated list of columns included in the preset)
$request : ServerRequestInterface
  • Request-context of the action that displays the preset
$id : int
  • Page ID where the records are stored

getDatabaseTable()

public getDatabaseTable() : string
Return values
string

getId()

public getId() : int
Return values
int

getRequest()

public getRequest() : ServerRequestInterface
Return values
ServerRequestInterface

setPresets()

public setPresets(array<string|int, mixed> $presets) : void
Parameters
$presets : array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results