Function __global->spreadsheet_open_write
Definitions
sources/files_spreadsheets_write.php
- Open spreadsheet for writing.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| &$path | ?PATH | Yes | No | required parameter | N/A | N/A | File to write into (null: create a temporary file and return by reference) |
| $filename | ?string | No | No | Null | N/A | N/A | Filename (null: derive from $path) |
| $algorithm | integer | No | No | 3 | N/A | N/A | An ALGORITHM_* constant |
| $charset | ?string | No | No | Blank (empty string) | N/A | N/A | The character set to write with (if supported) (null: website character set) |
Returns
- A subclass of CMS_Spreadsheet_Writer
- Type: object
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Open spreadsheet for writing.
*
* @param ?PATH $path File to write into (null: create a temporary file and return by reference)
* @param ?string $filename Filename (null: derive from $path)
* @param integer $algorithm An ALGORITHM_* constant
* @param ?string $charset The character set to write with (if supported) (null: website character set)
* @return object A subclass of CMS_Spreadsheet_Writer
*/
function spreadsheet_open_write(?string &$path, ?string $filename = null, int $algorithm = 3, ?string $charset = '') : object
* Open spreadsheet for writing.
*
* @param ?PATH $path File to write into (null: create a temporary file and return by reference)
* @param ?string $filename Filename (null: derive from $path)
* @param integer $algorithm An ALGORITHM_* constant
* @param ?string $charset The character set to write with (if supported) (null: website character set)
* @return object A subclass of CMS_Spreadsheet_Writer
*/
function spreadsheet_open_write(?string &$path, ?string $filename = null, int $algorithm = 3, ?string $charset = '') : object
