ec_receipt.php
Version
1.1.2.6 (checked in on 2008/03/24 at 02:40:12 by sime)
Description
These are hooks which are called using ec_receipt_invoke() or ec_receipt_alloc_invoke()
Functions
Name | Description |
|---|---|
| hook_allocation_info | Register allocation types to the receipt system. An allocation is literally an allocation of some money on a receipt (say from a payment gateway) against a transaction. |
| hook_alloc_allocation | tba (example is from store.module) |
| hook_alloc_build_items | tba (example is from store.module) |
| hook_alloc_get_address | The allocation object provider returns an appropriate address. Eg. store returns an address from the transaction object. |
| hook_alloc_get_currency | The allocation object provider returns currency. Eg. store returns the currency of the transaction object. |
| hook_alloc_get_customer | The allocation object provider returns the customer. Eg. store returns the customer from the transaction object. |
| hook_alloc_get_customer_names | The allocation object provider customer names from an allocation object. Eg. store returns the customers from the transaction object. |
| hook_alloc_get_invoice_no | The allocation object provider returns the invoice number of the allocation object. Eg. store returns the invoice number from the transaction object. |
| hook_alloc_get_items | The allocation object provider returns the items of the allocation object. Eg. store returns the product items from the transaction object. |
| hook_alloc_get_payment_data | Return the payment data of an allocation object. Eg. store returns the data previously assigned in 'set_payment_data' |
| hook_alloc_get_payment_form | I have no idea how an allocation provide returns a payment form since its not a receipt type - sime |
| hook_alloc_get_payment_type | Return the payment method of an allocation object. Eg. store returns the method assigned in 'set_payment_data' |
| hook_alloc_get_total | Return the total amount for an allocation object. Eg. store returns the total for a transaction. |
| hook_alloc_load | Load an allocation object. Eg. store returns the total for a transaction. |
| hook_alloc_set_payment_data | Allows an allocation object provider to assign payment data to its native object. Eg. store assigns payment data to its transaction. |
| hook_receipt_info | Register payments gateways to the e-Commerce Receipts system |
| hook_receipt_load | Load additional receipt information from the database. |
| hook_receipt_payment_form | Build a form for collecting the payment information. |
| hook_receipt_payment_url | |
| hook_receipt_process_payment | Using the information past from the payment form the system will process the payment and update the receipt. |
| hook_receipt_save | Save additional information about the receipt to the database. |