Docs For Class Hook

Class Hook_paypal

Description

copyright: ocProducts Ltd
license: Common Public Attribution License

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

Method Summary

?boolean auto_cancel (string $trans_id)

URLPATH get_ipn_url ()

float get_transaction_fee (float $amount)

array handle_transaction ()

tempcode make_cancel_button (ID_TEXT $purchase_id)

tempcode make_cart_transaction_button (array $items, tempcode $currency, AUTO_LINK $order_id)

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

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

?mixed store_shipping_address (AUTO_LINK $order_id)

string _get_payment_address ()

Methods

auto_cancel (line 111)

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

get_ipn_url (line 39)

Get the PayPal IPN URL.

return: The IPN url.

URLPATH get_ipn_url ()

get_transaction_fee (line 122)

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 132)

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 100)

Make a subscription cancellation button.

return: The button

tempcode make_cancel_button (ID_TEXT $purchase_id)

ID_TEXT $purchase_id: The purchase ID.

make_cart_transaction_button (line 231)

Make a transaction (payment) button for multiple shopping cart items

return: The button

tempcode make_cart_transaction_button (array $items, tempcode $currency, AUTO_LINK $order_id)

array $items: Items array
tempcode $currency: Currency symbol
AUTO_LINK $order_id: Order Id

make_subscription_button (line 87)

Make a subscription (payment) button.

return: The button

tempcode make_subscription_button (ID_TEXT $product, SHORT_TEXT $item_name, ID_TEXT $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.
ID_TEXT $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 54)

Make a transaction (payment) button.

return: The button

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

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

store_shipping_address (line 261)

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_payment_address (line 29)

Get the PayPal payment address.

return: The answer.

string _get_payment_address ()

Documentation generated on Sun, 02 Jan 2011 23:20:53 +0000 by phpDocumentor 1.4.3