ResultDataTrait
Table of Contents
Properties
Methods
- formatColumnValue() : scalar|null
- Returns final formatted column value
- outputCSV() : mixed
- Outputs headers and CSV directly to browser for download
- outputSpreadsheet() : mixed
- Create PhpSpreadsheet document and output directly to browser for download
- processData() : mixed
Properties
$format
Requested file format.
protected
string
$format
= 'array'
'array' will return a normal api result, with table headers as the first row. 'csv', etc. will directly output a file to the browser.
Tags
$formats
private
mixed
$formats
= ['array' => ['writer' => 'JSON', 'mime' => 'application/json'], 'csv' => ['writer' => 'CSV', 'mime' => 'text/csv'], 'xlsx' => ['writer' => 'Xlsx', 'mime' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'], 'ods' => ['writer' => 'Ods', 'mime' => 'application/vnd.oasis.opendocument.spreadsheet'], 'pdf' => ['writer' => 'Dompdf', 'mime' => 'application/pdf']]
Methods
formatColumnValue()
Returns final formatted column value
protected
formatColumnValue(array<string|int, mixed> $col, array<string|int, mixed> $value) : scalar|null
Parameters
- $col : array<string|int, mixed>
- $value : array<string|int, mixed>
Return values
scalar|nulloutputCSV()
Outputs headers and CSV directly to browser for download
private
outputCSV(array<string|int, mixed> $rows, array<string|int, mixed> $columns, string $fileName) : mixed
Parameters
- $rows : array<string|int, mixed>
- $columns : array<string|int, mixed>
- $fileName : string
outputSpreadsheet()
Create PhpSpreadsheet document and output directly to browser for download
private
outputSpreadsheet(array<string|int, mixed> $rows, array<string|int, mixed> $columns) : mixed
Parameters
- $rows : array<string|int, mixed>
- $columns : array<string|int, mixed>
processData()
private
processData(mixed $label, mixed $columns, mixed $rows, mixed &$fileName) : mixed
Parameters
- $label : mixed
- $columns : mixed
- $rows : mixed
- $fileName : mixed