Function Hook_task_export_ecom_transactions->run
Definitions
sources/hooks/systems/tasks/export_ecom_transactions.php
- Run the task hook.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $filter_username | ID_TEXT | Blank (empty string) | N/A | N/A | Filter transactions by username (blank: do not filter) |
| $filter_txn_id | ID_TEXT | Blank (empty string) | N/A | N/A | Filter by transaction ID (blank: do not filter) |
| $filter_purchase_id | SHORT_TEXT | Blank (empty string) | N/A | N/A | Filter by product-specific ID (blank: do not filter) |
| $_filter_status | LONG_TEXT | Blank (empty string) | N/A | N/A | Filter by comma-delimited transaction statuses (blank: do not filter) |
| $_filter_type_code | LONG_TEXT | Blank (empty string) | N/A | N/A | Filter by comma-delimited product type codes (blank: do not filter) |
| $filter_start | ?TIME | Null | N/A | N/A | Filter out all transactions before the given time (null: do not filter) |
| $filter_end | ?TIME | Null | N/A | N/A | Filter out all transactions after the given time (null: do not filter) |
| $file_type | ?string | Null | N/A | N/A | The file type to export with (null: default) |
Return
- 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