Docs For Class bluepay

Description

BluePay class to perform the majority of functions for handling payment gateway logic

author: ILance
version: $Revision: 1.0.0 $

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

Variable Summary

mixed $account

mixed $accountId

mixed $addr1

mixed $addr2

mixed $amount

mixed $approvedUrl

mixed $authCode

mixed $avsAllowed

mixed $avsResp

mixed $birthdate

mixed $city

mixed $country

mixed $custId

mixed $custIdState

mixed $cvv2

mixed $cvv2Allowed

mixed $cvv2Resp

mixed $declinedUrl

mixed $doAutocap

mixed $doRebill

mixed $error_email

mixed $expire

mixed $invoiceId

mixed $masterId

mixed $memo

mixed $message

mixed $missingUrl

mixed $mode

mixed $name1

mixed $name2

mixed $orderId

mixed $payType

mixed $rebAmount

mixed $rebCycles

mixed $rebDate

mixed $rebExpr

mixed $rebid

mixed $response

mixed $secretKey

mixed $ssn

mixed $state

mixed $status

mixed $tax

mixed $tip

mixed $tps

mixed $transId

mixed $transType

mixed $userId

mixed $zip

Method Summary

bluepay bluepay ([ $bluepay_post_vars = array()])

void do_http_build_query ( &$data)

void formatAmount ( $amount)

void format_length ([ $length = 0], [ $unit = ''])

void format_unit ([ $length = 0], [ $unit = ''])

void make_hash ()

void parseResponse ()

string print_recurring_payment_form ([string $startdate = ''], [integer $subscriptionid = 0], [string $roleid = 0], [integer $amount = 0], [string $totaloccurrences = 9999], [integer $trialamount = 0], [string $trialoccurrences = 0], [integer $units = ''], [string $length = 0], [string $description = ''], [integer $onsubmit = ''], [integer $ismodify = 0], [string $iscancel = 0])

void process ()

void rebAdd ()

void setCustInfo ()

void toString ( $string)

Variables

mixed $account = '' (line 38)

mixed $accountId = '' (line 26)

mixed $addr1 = '' (line 48)

mixed $addr2 = '' (line 49)

mixed $amount = '' (line 45)

mixed $approvedUrl = '' (line 89)

mixed $authCode = '' (line 83)

mixed $avsAllowed = '' (line 72)

mixed $avsResp = '' (line 81)

mixed $birthdate = '' (line 42)

mixed $city = '' (line 50)

mixed $country = '' (line 53)

mixed $custId = '' (line 43)

mixed $custIdState = '' (line 44)

mixed $cvv2 = '' (line 39)

mixed $cvv2Allowed = '' (line 73)

mixed $cvv2Resp = '' (line 82)

mixed $declinedUrl = '' (line 90)

mixed $doAutocap = '' (line 71)

mixed $doRebill = '' (line 64)

mixed $error_email = '' (line 87)

mixed $expire = '' (line 40)

mixed $invoiceId = '' (line 59)

mixed $masterId = '' (line 32)

mixed $memo = '' (line 54)

mixed $message = '' (line 84)

mixed $missingUrl = '' (line 91)

mixed $mode = '' (line 31)

mixed $name1 = '' (line 46)

mixed $name2 = '' (line 47)

mixed $orderId = '' (line 58)

mixed $payType = '' (line 30)

mixed $rebAmount = '' (line 68)

mixed $rebCycles = '' (line 67)

mixed $rebDate = '' (line 65)

mixed $rebExpr = '' (line 66)

mixed $rebid = '' (line 85)

mixed $response = '' (line 76)

mixed $secretKey = '' (line 33)

mixed $ssn = '' (line 41)

mixed $state = '' (line 51)

mixed $status = '' (line 80)

mixed $tax = '' (line 61)

mixed $tip = '' (line 60)

mixed $tps = '' (line 28)

mixed $transId = '' (line 79)

mixed $transType = '' (line 29)

mixed $userId = '' (line 27)

mixed $zip = '' (line 52)

Methods

Constructor bluepay (line 100)

* __construct()

Constructor method, sets the account, secret key, and the mode properties. These will default to the constant values if not specified.

bluepay bluepay ([ $bluepay_post_vars = array()])

$bluepay_post_vars

do_http_build_query (line 161)

Performs the exact same operations as the PHP5 'http_build_query' function

void do_http_build_query ( &$data)

&$data

formatAmount (line 233)

* formatAmount()

Will format an amount value to be in the expected format for the POST.

void formatAmount ( $amount)

$amount

format_length (line 401)

void format_length ([ $length = 0], [ $unit = ''])

$length
$unit

format_unit (line 411)

void format_unit ([ $length = 0], [ $unit = ''])

$length
$unit

make_hash (line 125)

void make_hash ()

parseResponse (line 336)

* parseResponse()

This method will parse the response parameter values into the respective properties.

void parseResponse ()

print_recurring_payment_form (line 367)

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

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

string print_recurring_payment_form ([string $startdate = ''], [integer $subscriptionid = 0], [string $roleid = 0], [integer $amount = 0], [string $totaloccurrences = 9999], [integer $trialamount = 0], [string $trialoccurrences = 0], [integer $units = ''], [string $length = 0], [string $description = ''], [integer $onsubmit = ''], [integer $ismodify = 0], [string $iscancel = 0])

string $startdate: subscription start date (default now/today) format: YYYY-MM-DD
integer $subscriptionid: subscription id
string $roleid: amount to process
integer $amount: total occurrences (max 9999) default 9999 (no end date until user cancels themselve)
string $totaloccurrences: trial amount to process (default 0)
integer $trialamount: trial occurrences (max 99) default 0
string $trialoccurrences: unit (format: months or days)
integer $units: length (format: can be 1 - 12 or 7 - 365)
string $length: transaction description
string $description: js onsubmit form code
integer $onsubmit: ismodify subscription modify update for authorize.net (default 0 = no)
integer $ismodify: iscancel subscription cancellation request (default 0 = no)
string $iscancel: custom subscription info

process (line 243)

* process()

Will first generate the tamper proof seal, then populate the POST query, then send it, and store the response, and finally parse the response.

void process ()

rebAdd (line 188)

* rebAdd()

Will add a rebilling cycle.

void rebAdd ()

setCustInfo (line 203)

* setCustInfo()

Sets the customer specified info.

void setCustInfo ()

toString (line 134)

Helper function for do_http_build_query

void toString ( $string)

$string