Docs For Class moneybookers

Class moneybookers

Description

Moneybookers class to perform the majority of functions including ipn response handling

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.moneybookers.inc.php (line 23)

Variable Summary

mixed $currencies_accepted

mixed $error_email

mixed $moneybookers_post_vars

mixed $moneybookers_response

mixed $send_time

mixed $timeout

Method Summary

array moneybookers ([array $moneybookers_post_vars = array()])

nothing error_out ([string $text = ''])

void generate_md5_digest ()

string get_payment_status ()

string get_raw_payment_status ()

string get_recurring_transaction_type ()

string get_transaction_amount ()

string get_transaction_currency ()

string get_transaction_id ()

string get_transaction_md5_digest ()

string get_transaction_merchant_id ()

string get_transaction_type ()

bool is_verified ()

string print_direct_payment_form ([string $amount = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $customencrypted = ''], [string $returnurl = ''])

string print_payment_form ([integer $userid = 0], [string $payer_email = ''], [string $amount = 0], [integer $invoiceid = 0], [integer $subscriptionid = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $passphrase = ''], [string $customencrypted = ''], [bool $testmode = 0])

string print_recurring_payment_form ([string $merchantid = ''], [string $amount = 0], [string $units = ''], [integer $length = 0], [string $description = ''], [string $currency = ''], [string $customencrypted = ''], [string $onsubmit = ''])

Variables

mixed $currencies_accepted = array('USD', 'GBP', 'EUR', 'CAD', 'HKD', 'SGD', 'JPY', 'AUD', 'CHF', 'DKK', 'SEK', 'NOK', 'ILS', 'MYR', 'NZD', 'TRY', 'TWD', 'THB', 'CZK', 'HUF', 'SKK', 'EEK', 'BGN', 'PLN', 'ISK', 'INR', 'LVL', 'KRW', 'ZAR', 'RON', 'HRK', 'LTL') (line 30)

mixed $error_email (line 28)

mixed $moneybookers_post_vars = array() (line 25)

mixed $moneybookers_response (line 26)

mixed $send_time (line 29)

mixed $timeout (line 27)

Methods

Constructor moneybookers (line 39)

Function for parsing incoming variables from the payment gateway

array moneybookers ([array $moneybookers_post_vars = array()])

array $moneybookers_post_vars: posted moneybookers keys and values

error_out (line 324)

Function for sending any error emails from the process to the administrator.

nothing error_out ([string $text = ''])

string $text: error message text

generate_md5_digest (line 51)

void generate_md5_digest ()

get_payment_status (line 216)

Function for storing the processed payment status for later retrevial.

return: payment status

string get_payment_status ()

get_raw_payment_status (line 236)

Function for storing the processed payment status for later retrevial.

return: payment status

string get_raw_payment_status ()

get_recurring_transaction_type (line 290)

Function for storing the processed recurring payment transaction type for later retrevial.

return: transaction type

string get_recurring_transaction_type ()

get_transaction_amount (line 257)

Function for storing the processed payment transaction amount for later retrevial.

return: transaction id

string get_transaction_amount ()

get_transaction_currency (line 267)

Function for storing the processed payment currency for later retrevial.

return: transaction id

string get_transaction_currency ()

get_transaction_id (line 247)

Function for storing the processed payment transaction id for later retrevial.

return: transaction id

string get_transaction_id ()

get_transaction_md5_digest (line 302)

Function for fetching the md5sig sent to us in a response from the payment gateway

return: transaction type

string get_transaction_md5_digest ()

get_transaction_merchant_id (line 312)

Function for fetching merchant id once it's provided to us from the payment gateway

return: transaction type

string get_transaction_merchant_id ()

get_transaction_type (line 277)

Function for storing the processed payment transaction type for later retrevial.

return: transaction type

string get_transaction_type ()

is_verified (line 186)

Function for determining (internally) if the processed transaction has been verified (true or false)

return: true or false

bool is_verified ()

print_direct_payment_form (line 122)

Function for printing the payment processor custom generated form via POST method.

return: HTML representation of the form (without the ending </form>)

string print_direct_payment_form ([string $amount = 0], [string $description = ''], [string $merchantid = ''], [string $currency = ''], [string $customencrypted = ''], [string $returnurl = ''])

string $amount: amount to process
string $description: transaction description
string $merchantid: sellers payment email
string $currency: master currency
string $customencrypted: custom generated payment repsonse arguments to be decrypted by ilance payment processor
string $returnurl: return url

print_payment_form (line 82)

Function for printing the payment processor custom generated form via POST method.

return: HTML representation of the form (without the ending </form>)

integer $userid: user id
string $payer_email: payer email address
string $amount: amount to process
integer $invoiceid: associated invoice id
integer $subscriptionid: associated subscription id
string $description: transaction description
string $merchantid: merchant id
string $currency: master currency
string $passphrase: pass phrase used in some processors (usually stored with processor also)
string $customencrypted: custom generated payment repsonse arguments to be decrypted by ilance payment processor
bool $testmode: defines if this payment form should return a test - mode parameter (if available)

print_recurring_payment_form (line 156)

Function for printing the payment processor custom generated form via POST method.

return: HTML representation of the form (without the ending </form>)

string $merchantid: payer email address
string $amount: amount to process
string $units: units
integer $length: length
string $description: transaction description
string $currency: master currency
string $customencrypted: custom generated payment repsonse arguments to be decrypted by ilance payment processor
string $onsubmit: onsubmit form submit code

Documentation generated on Mon, 08 Aug 2011 17:40:55 +0200 by phpDocumentor 1.4.1