ExporterInterface Interface Reference
Detailed Description
Interface ExporterInterface
Member Function Documentation
export |
( |
$ |
page_id = NULL |
) |
|
Export data as a string
- Parameters:
-
| mixed | $page_id (Optional) Defaults to NULL. Set this to export a single page. |
- Returns:
- string
Implemented in Exporter, and XLSXExporter.
formatColumn |
( |
$ |
column, |
|
|
$ |
format_code | |
|
) |
| | |
Format a single column with format by string
- Parameters:
-
| string | $column |
| string | $format_code
|
- Returns:
- $this
Implemented in Exporter, and XLSXExporter.
Get the filename
- Returns:
- string
Implemented in Exporter.
getHeader |
( |
$ |
page_id = 0 |
) |
|
Return an array containing the header row values for a page
- Parameters:
-
| mixed | $page_id (Optional) Defaults to 0. |
- Returns:
- array
- The keys of the header MUST match the keys of each row of data
Implemented in Exporter.
save |
( |
$ |
filename = '' , |
|
|
$ |
page_id = NULL | |
|
) |
| | |
Save as a file to the server
- Parameters:
-
| string | $filename The correct extension will be appended to this string |
| mixed | $page_id (Optional) Defaults to NULL. Set this to export a single page. |
Implemented in Exporter, and XLSXExporter.
Set the export data object
- Parameters:
-
- Returns:
- $this
Implemented in Exporter.
setFilename |
( |
$ |
filename |
) |
|
Getter/Setter for the filename
- Parameters:
-
| string | $filename Extension (if present in $filename) will be corrected based on the object |
- Returns:
- string The final $filename with correct extension
Implemented in Exporter.
The documentation for this interface was generated from the following file: