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
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$filter_username ID_TEXT No No Blank (empty string) N/A N/A Filter transactions by username (blank: do not filter)
$filter_txn_id ID_TEXT No No Blank (empty string) N/A N/A Filter by transaction ID (blank: do not filter)
$filter_purchase_id SHORT_TEXT No No Blank (empty string) N/A N/A Filter by product-specific ID (blank: do not filter)
$_filter_status LONG_TEXT No No Blank (empty string) N/A N/A Filter by comma-delimited transaction statuses (blank: do not filter)
$_filter_type_code LONG_TEXT No No Blank (empty string) N/A N/A Filter by comma-delimited product type codes (blank: do not filter)
$filter_start ?TIME No No Null N/A N/A Filter out all transactions before the given time (null: do not filter)
$filter_end ?TIME No No Null N/A N/A Filter out all transactions after the given time (null: 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  ID_TEXT $filter_username Filter transactions by username (blank: do not filter)
 * @param  ID_TEXT $filter_txn_id Filter by transaction ID (blank: do not filter)
 * @param  SHORT_TEXT $filter_purchase_id Filter by product-specific ID (blank: do not filter)
 * @param  LONG_TEXT $_filter_status Filter by comma-delimited transaction statuses (blank: do not filter)
 * @param  LONG_TEXT $_filter_type_code Filter by comma-delimited product type codes (blank: do not filter)
 * @param  ?TIME $filter_start Filter out all transactions before the given time (null: do not filter)
 * @param  ?TIME $filter_end Filter out all transactions after the given time (null: 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(string $filter_username = '', string $filter_txn_id = '', string $filter_purchase_id = '', string $_filter_status = '', string $_filter_type_code = '', ?int $filter_start = null, ?int $filter_end = null, ?string $file_type = null) : ?array