Function Hook_ecommerce_custom->actualiser

Definitions

sources/hooks/systems/ecommerce/custom.php

  • Handling of a product purchase change state.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$type_code ID_TEXT No No required parameter N/A N/A The product codename
$purchase_id ID_TEXT No No required parameter N/A N/A The purchase ID
$details array No No required parameter N/A N/A Details of the product, with added keys: TXN_ID, STATUS, ORDER_STATUS

Returns

  • Whether the product was automatically dispatched (if not then hopefully this function sent a staff notification)
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Handling of a product purchase change state.
 *
 * @param  ID_TEXT $type_code The product codename
 * @param  ID_TEXT $purchase_id The purchase ID
 * @param  array $details Details of the product, with added keys: TXN_ID, STATUS, ORDER_STATUS
 * @return boolean Whether the product was automatically dispatched (if not then hopefully this function sent a staff notification)
 */
public function actualiser(string $type_code, string $purchase_id, array $details) : bool