Docs For Class paypal

Class paypal

Description

Paypal class to perform the majority of functions including ipn response handling.

author: ILance
version: $Revision: 1.0.0 $

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

Variable Summary

mixed $currencies_accepted

mixed $error_email

mixed $paypal_post_vars

mixed $paypal_response

mixed $send_time

mixed $timeout

Method Summary

array paypal ([array $paypal_post_vars = array()])

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

string get_payment_status ()

string get_payment_type ()

string get_transaction_amount ()

string get_transaction_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 $payer_email = ''], [string $subscriptionid = 0], [string $amount = 0], [integer $units = ''], [string $length = 0], [string $title = ''], [string $description = ''], [string $currency = ''], [integer $customencrypted = ''], [ $onsubmit = ''], [ $ismodify = 0])

nothing send_response ()

Variables

mixed $currencies_accepted = array('USD', 'GBP', 'EUR', 'CAD') (line 30)

mixed $error_email (line 28)

mixed $paypal_post_vars = array() (line 25)

mixed $paypal_response (line 26)

mixed $send_time (line 29)

mixed $timeout (line 27)

Methods

Constructor paypal (line 39)

Function for parsing incoming variables from the payment gateway

array paypal ([array $paypal_post_vars = array()])

array $paypal_post_vars: posted paypal keys and values

error_out (line 319)

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

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

string $text: error message text

get_payment_status (line 263)

Function for storing the processed payment status for later retrevial.

return: payment status

string get_payment_status ()

get_payment_type (line 273)

Function for storing the processed payment type for later retrevial.

return: payment type

string get_payment_type ()

get_transaction_amount (line 295)

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

return: transaction id

string get_transaction_amount ()

get_transaction_id (line 285)

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

return: transaction id

string get_transaction_id ()

get_transaction_type (line 307)

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

return: transaction type

string get_transaction_type ()

is_verified (line 248)

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

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

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

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

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

string $payer_email: payer email address
string $subscriptionid: amount to process
string $amount: unit
integer $units: length
string $length: transaction description
string $title: gateway currency to use
string $description: custom generated payment repsonse arguments to be decrypted by ilance payment processor
string $currency: js onsubmit form code
integer $customencrypted: ismodify subscription modify update for paypal
$onsubmit
$ismodify

send_response (line 187)

Function for sending a repsonse to the payment gateway for verification of payment authentication and status.

nothing send_response ()

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