Function Hook_task_export_catalogue->run
Definitions
sources/hooks/systems/tasks/export_catalogue.php
- Run the task hook.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $catalogue_name | ID_TEXT | No | No | required parameter | N/A | N/A | The catalogue to export |
| $file_type | ?string | No | No | Null | N/A | N/A | The file type to export with (null: default) |
Returns
- A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Run the task hook.
*
* @param ID_TEXT $catalogue_name The catalogue to export
* @param ?string $file_type The file type to export with (null: default)
* @return ?array A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
*/
public function run(string $catalogue_name, ?string $file_type = null) : ?array
* Run the task hook.
*
* @param ID_TEXT $catalogue_name The catalogue to export
* @param ?string $file_type The file type to export with (null: default)
* @return ?array A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
*/
public function run(string $catalogue_name, ?string $file_type = null) : ?array
