+
+
+
+ export()
+
+
+
+
+
+ Export the data to an Excel file.
+
+
+ public
+ export(string $filename) : bool
+
+
+
+
+
+ Parameters
+
+ -
+ $filename
+ : string
+
+ -
+
The file name to export to.
+
+
+
+
+
+
+
+
+
+
+ Return values
+ bool
+ —
+ status of export based PHP Office reader load() result
+
+
+
+
+
+
+
+ setAppendMode()
+
+
+
+
+
+ Set whether the export should append to an existing file or replace the file.
+
+
+ public
+ setAppendMode(bool $appendMode) : static
+
+
+
+
+
+ Parameters
+
+ -
+ $appendMode
+ : bool
+
+ -
+
If true, the export will append to an existing file.
+If false, the export will replace the file.
+
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ setChunkSize()
+
+
+
+
+
+ Set the number of data rows to be processed in each chunk.
+
+
+ public
+ setChunkSize(int $chunkSize) : static
+
+
+
+
+ When exporting large datasets, processing the data in chunks can help
+reduce the memory footprint of the export process. The chunk size is
+the number of data rows that are processed at a time.
+
+
+ Parameters
+
+ -
+ $chunkSize
+ : int
+
+ -
+
The number of data rows to be processed in each chunk.
+
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ setData()
+
+
+
+
+
+
+
+ public
+ setData(mixed $data) : static
+
+
+
+
+
+ Parameters
+
+ -
+ $data
+ : mixed
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+
+
+ Set the headers to be displayed on the first row of the export.
+
+
+ public
+ setHeaders(array<string|int, mixed> $headers) : static
+
+
+
+
+
+ Parameters
+
+ -
+ $headers
+ : array<string|int, mixed>
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ setHiddens()
+
+
+
+
+
+ Set the fields which should not appear in the export.
+
+
+ public
+ setHiddens(array<string|int, mixed> $hiddens) : static
+
+
+
+
+
+ Parameters
+
+ -
+ $hiddens
+ : array<string|int, mixed>
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+ setMapping()
+
+
+
+
+
+ Set the mapping of header => field names.
+
+
+ public
+ setMapping(array<string|int, mixed> $mapping) : static
+
+
+
+
+
+ Parameters
+
+ -
+ $mapping
+ : array<string|int, mixed>
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+
+
+ Set the meta settings of the export.
+
+
+ public
+ setMetaSettings(array<string|int, mixed> $metaSettings) : static
+
+
+
+
+ The meta settings are written to the spreadsheet properties.
+Supported keys:
+
+
+
+ Parameters
+
+ -
+ $metaSettings
+ : array<string|int, mixed>
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+
+
+ Set whether the export should write the header row or not.
+
+
+ public
+ setSkipHeader(bool $skipHeader) : static
+
+
+
+
+ The header row is the first row of the spreadsheet and is used to
+label the columns. If this is set to true, the export will skip
+writing the header row.
+
+
+ Parameters
+
+ -
+ $skipHeader
+ : bool
+
+ -
+
If true, the export will skip writing the header row.
+
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+
+
+ Set the sub headers to be displayed on the second row of the export.
+
+
+ public
+ setSubHeaders(array<string|int, mixed> $subHeaders) : static
+
+
+
+
+
+ Parameters
+
+ -
+ $subHeaders
+ : array<string|int, mixed>
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ static
+
+
+
+
+
+
+
+ Apply the meta settings to the spreadsheet.
+
+
+ protected
+ applyMetaSettings(Spreadsheet $spreadsheet) : void
+
+
+
+
+ The meta settings are applied to the spreadsheet properties. The
+supported meta settings are:
+
+-
+
author: The author of the spreadsheet.
+-
+
title: The title of the spreadsheet.
+
+
+
+ Parameters
+
+ -
+ $spreadsheet
+ : Spreadsheet
+
+ -
+
The spreadsheet to apply the meta
+settings to.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Format a value for export.
+
+
+ protected
+ formatValue(string $mappingKey, mixed $value[, mixed $rowItem = null ]) : mixed
+
+
+
+
+ This method is called once for each value that is exported.
+The default implementation simply returns the value as is,
+but you can override this method in your class to change the
+behavior.
+
+
+ Parameters
+
+ -
+ $mappingKey
+ : string
+
+ -
+
The key of the mapped column that is being exported.
+
+
+
+ -
+ $value
+ : mixed
+
+ -
+
The value that is being exported.
+
+
+
+ -
+ $rowItem
+ : mixed
+ = null
+ -
+
The current processing row item
+
+
+
+
+
+
+
+
+
+
+ Return values
+ mixed
+ —
+
+
+
+
+
+
+
+ getColumnLetter()
+
+
+
+
+
+ Get the column letter for a mapping key.
+
+
+ protected
+ getColumnLetter(string $mappingKey) : string
+
+
+
+
+
+ Parameters
+
+ -
+ $mappingKey
+ : string
+
+ -
+
+
+
+
+
+
+
+
+
+ Return values
+ string
+
+
+
+
+
+
+
+ Get a header value from the headers array.
+
+
+ protected
+ getHeader(string $header) : string
+
+
+
+
+ If the header does not exist, the value passed as an argument is returned.
+
+
+ Parameters
+
+ -
+ $header
+ : string
+
+ -
+
The header for which to get the value
+
+
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+
+
+
+
+
+
+
+
+
+ Get a header from a mapping key.
+
+
+ protected
+ getHeaderFromMappingKey(string $mappingKey) : string|null
+
+
+
+
+
+ Parameters
+
+ -
+ $mappingKey
+ : string
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ The header if found, null otherwise
+
+
+
+
+
+
+
+
+
+ Get the mapping key from a header.
+
+
+ protected
+ getMappingKeyFromHeader(string $header) : string|null
+
+
+
+
+
+ Parameters
+
+ -
+ $header
+ : string
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Return values
+ string|null
+ —
+ The mapping key if found, null otherwise
+
+
+
+
+
+
+
+
+
+ Get a sub-header value from the sub headers array.
+
+
+ protected
+ getSubHeader(string $header) : string
+
+
+
+
+ If the sub-header does not exist, an empty string is returned.
+
+
+ Parameters
+
+ -
+ $header
+ : string
+
+ -
+
The header for which to get the sub-header value
+
+
+
+
+
+
+
+
+
+
+ Return values
+ string
+ —
+
+
+
+
+
+
+
+ getValue()
+
+
+
+
+
+ Get a value from the data row for export.
+
+
+ protected
+ getValue(array<string|int, mixed> $row[, string $key = null ]) : mixed
+
+
+
+
+ This method is called once for each value that is exported.
+
+
+ Parameters
+
+ -
+ $row
+ : array<string|int, mixed>
+
+ -
+
+
+ -
+ $key
+ : string
+ = null
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Write the headers to the Excel sheet.
+
+
+ protected
+ writeHeaders(Worksheet $sheet) : void
+
+
+
+
+
+ Parameters
+
+ -
+ $sheet
+ : Worksheet
+
+ -
+
The worksheet to write the headers to.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ writeRow()
+
+
+
+
+
+ Write a single row of data to the spreadsheet.
+
+
+ protected
+ writeRow(Worksheet $sheet, array<string|int, mixed> $row, int $rowIndex) : void
+
+
+
+
+
+ Parameters
+
+ -
+ $sheet
+ : Worksheet
+
+ -
+
The worksheet to write the row to.
+
+
+
+ -
+ $row
+ : array<string|int, mixed>
+
+ -
+
The row of data to write.
+
+
+
+ -
+ $rowIndex
+ : int
+
+ -
+
The index of the row to write.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dataGet()
+
+
+
+
+
+ Get an item from an array or object using "dot" notation.
+
+
+ private
+ static dataGet(mixed $target, string|array<string|int, mixed>|int|null $key[, mixed $default = null ]) : mixed
+
+
+
+
+
+ Parameters
+
+ -
+ $target
+ : mixed
+
+ -
+
+
+ -
+ $key
+ : string|array<string|int, mixed>|int|null
+
+ -
+
+
+ -
+ $default
+ : mixed
+ = null
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ first()
+
+
+
+
+
+
+
+ private
+ static first(array<string|int, mixed> $array[, mixed $callback = null ][, mixed $default = null ]) : mixed
+
+
+
+
+
+ Parameters
+
+ -
+ $array
+ : array<string|int, mixed>
+
+ -
+
+
+ -
+ $callback
+ : mixed
+ = null
+ -
+
+
+ -
+ $default
+ : mixed
+ = null
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+