Docs For Class Hook

Description

copyright: ocProducts Ltd
license: Common Public Attribution License

Located in /sources/hooks/systems/ecommerce_via/worldpay.php (line 21)

Method Summary

?boolean auto_cancel (string $trans_id)

string generate_trans_id ()

URLPATH get_ipn_url ()

tempcode get_logos ()

float get_transaction_fee (float $amount)

array handle_transaction ()

tempcode make_cancel_button (ID_TEXT $purchase_id)

tempcode make_subscription_button (ID_TEXT $product, SHORT_TEXT $item_name, AUTO_LINK $purchase_id, float $amount, integer $length, ID_TEXT $length_units, ID_TEXT $currency)

tempcode make_transaction_button (ID_TEXT $product, SHORT_TEXT $item_name, AUTO_LINK $purchase_id, float $amount, ID_TEXT $currency)

?mixed store_shipping_address (AUTO_LINK $order_id)

string _get_username ()

Methods

auto_cancel (line 181)

Find whether the hook auto-cancels (if it does, auto cancel the given trans-id).

return: True: yes. False: no. (NULL: cancels via a user-URL-directioning)

?boolean auto_cancel (string $trans_id)

string $trans_id: Transaction ID to cancel

generate_trans_id (line 71)

Generate a transaction ID.

return: A transaction ID.

string generate_trans_id ()

get_ipn_url (line 47)

Get the IPN URL.

return: The IPN url.

URLPATH get_ipn_url ()

get_logos (line 57)

Get the card/gateway logos and other gateway-required details.

return: The stuff.

tempcode get_logos ()

get_transaction_fee (line 192)

Find a transaction fee from a transaction amount. Regular fees aren't taken into account.

return: The fee

float get_transaction_fee (float $amount)

float $amount: A transaction amount.

handle_transaction (line 202)

Handle IPN's. The function may produce output, which would be returned to the Payment Gateway. The function may do transaction verification.

return: A long tuple of collected data.

array handle_transaction ()

make_cancel_button (line 169)

Make a subscription cancellation button.

return: The button

tempcode make_cancel_button (ID_TEXT $purchase_id)

ID_TEXT $purchase_id: The purchase ID.

make_subscription_button (line 121)

Make a subscription (payment) button.

return: The button

tempcode make_subscription_button (ID_TEXT $product, SHORT_TEXT $item_name, AUTO_LINK $purchase_id, float $amount, integer $length, ID_TEXT $length_units, ID_TEXT $currency)

ID_TEXT $product: The product codename.
SHORT_TEXT $item_name: The human-readable product title.
AUTO_LINK $purchase_id: The purchase ID.
float $amount: A transaction amount.
integer $length: The subscription length in the units.
ID_TEXT $length_units: The length units.
ID_TEXT $currency: The currency to use.

make_transaction_button (line 86)

Make a transaction (payment) button.

return: The button

tempcode make_transaction_button (ID_TEXT $product, SHORT_TEXT $item_name, AUTO_LINK $purchase_id, float $amount, ID_TEXT $currency)

ID_TEXT $product: The product codename.
SHORT_TEXT $item_name: The human-readable product title.
AUTO_LINK $purchase_id: The purchase ID.
float $amount: A transaction amount.
ID_TEXT $currency: The currency to use.

store_shipping_address (line 269)

Store shipping address for orders

return: Address id (NULL: No address record found)

?mixed store_shipping_address (AUTO_LINK $order_id)

AUTO_LINK $order_id: Order id

_get_username (line 37)

Get the gateway username.

return: The answer.

string _get_username ()

Class Hook_worldpay