Docs For Class cashu

Description

Cashu class to perform the majority of functions including ipn response handling within ILance.

author: ILance
version: $Revision: 1.0.0 $

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

Variable Summary

mixed $cashu_post_vars

mixed $cashu_response

mixed $currencies_accepted

mixed $error_email

mixed $send_time

mixed $timeout

Method Summary

array cashu ([array $cashu_post_vars = array()])

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

void generate_md5_digest ([ $total = 0])

string get_transaction_amount ()

string get_transaction_currency ()

string get_transaction_id ()

string get_transaction_md5_digest ()

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

Variables

mixed $cashu_post_vars = array() (line 25)

mixed $cashu_response (line 26)

mixed $currencies_accepted = array('USD', 'CSH', 'AED', 'EUR', 'JOD', 'EGP', 'SAR') (line 30)

mixed $error_email (line 28)

mixed $send_time (line 29)

mixed $timeout (line 27)

Methods

Constructor cashu (line 39)

Function for parsing incoming variables from the payment gateway

array cashu ([array $cashu_post_vars = array()])

array $cashu_post_vars: posted cashu keys and values

error_out (line 193)

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 ([ $total = 0])

$total

get_transaction_amount (line 181)

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

return: transaction id

string get_transaction_amount ()

get_transaction_currency (line 151)

Function for storing the processed payment currency for later retrevial.

return: transaction id

string get_transaction_currency ()

get_transaction_id (line 171)

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

return: transaction id

string get_transaction_id ()

get_transaction_md5_digest (line 161)

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

return: transaction type

string get_transaction_md5_digest ()

is_verified (line 131)

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

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

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

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

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

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)