Function CMS_Spreadsheet_Writer->output_and_exit
Definitions
sources/files_spreadsheets_write.php
- Output the spreadsheet we've written and exit.If generating the spreadsheet used here is intensive, you shouldn't be using this, you should be using a task.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $filename | ?ID_TEXT | No | No | required parameter | N/A | N/A | Filename we will be using (null: try and derive from $outfile_path, otherwise generate a .csv filename) |
| $is_tmp_file | boolean | No | No | False | N/A | N/A | If the path we've been working with is a temporary file, and therefore needs to be deleted |
Preview
Code (PHP)
/**
* Output the spreadsheet we've written and exit.If generating the spreadsheet used here is intensive, you shouldn't be using this, you should be using a task.
*
* @param ?ID_TEXT $filename Filename we will be using (null: try and derive from $outfile_path, otherwise generate a .csv filename)
* @param boolean $is_tmp_file If the path we've been working with is a temporary file, and therefore needs to be deleted
*/
public function output_and_exit(?string $filename, bool $is_tmp_file = false)
* Output the spreadsheet we've written and exit.If generating the spreadsheet used here is intensive, you shouldn't be using this, you should be using a task.
*
* @param ?ID_TEXT $filename Filename we will be using (null: try and derive from $outfile_path, otherwise generate a .csv filename)
* @param boolean $is_tmp_file If the path we've been working with is a temporary file, and therefore needs to be deleted
*/
public function output_and_exit(?string $filename, bool $is_tmp_file = false)
