Function Hook_task_export_ecom_subscriptions->run
Definitions
sources/hooks/systems/tasks/export_ecom_subscriptions.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 |
|---|---|---|---|---|---|---|---|
| $filter_manual | BINARY | No | No | 1 | N/A | N/A | Whether to only include manual transactions |
| $filter_username | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | Filter by username (blank: do not filter) |
| $_filter_state | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | Filter by transaction state (comma-delimited) (blank: do not filter) |
| $_filter_type_code | LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | Filter by products (comma-delimited) (blank: do not filter) |
| $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 BINARY $filter_manual Whether to only include manual transactions
* @param SHORT_TEXT $filter_username Filter by username (blank: do not filter)
* @param SHORT_TEXT $_filter_state Filter by transaction state (comma-delimited) (blank: do not filter)
* @param LONG_TEXT $_filter_type_code Filter by products (comma-delimited) (blank: do not filter)
* @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(int $filter_manual = 1, string $filter_username = '', string $_filter_state = '', string $_filter_type_code = '', ?string $file_type = null) : ?array
* Run the task hook.
*
* @param BINARY $filter_manual Whether to only include manual transactions
* @param SHORT_TEXT $filter_username Filter by username (blank: do not filter)
* @param SHORT_TEXT $_filter_state Filter by transaction state (comma-delimited) (blank: do not filter)
* @param LONG_TEXT $_filter_type_code Filter by products (comma-delimited) (blank: do not filter)
* @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(int $filter_manual = 1, string $filter_username = '', string $_filter_state = '', string $_filter_type_code = '', ?string $file_type = null) : ?array
