Payment Class Reference

Inheritance diagram for Payment:

[legend]

Collaboration diagram for Payment:

[legend]

List of all members.

Public Member Functions
	init ()
	render ()
	changeshipping ()
	validatePayment ()
	getPaymentList ()
	getAllSets ()
	getAllSetsCnt ()
	getEmptyPayment ()
	getPaymentError ()
	getPaymentErrorText ()
	getDynValue ()
	getCheckedPaymentId ()
	getPaymentCnt ()
	getCreditYears ()
Protected Member Functions
	_setDefaultEmptyPayment ()
	_unsetPaymentErrors ()
	_setDeprecatedValues (&$aPaymentList, $oBasket=null)
	_assignDebitNoteParams ()
	_filterDynData ()
Protected Attributes
	$_oPaymentList = null
	$_iPaymentCnt = null
	$_aAllSets = null
	$_iAllSetsCnt = null
	$_oEmptyPayment = null
	$_sPaymentError = null
	$_sPaymentErrorText = null
	$_aDynValue = null
	$_sCheckedId = null
	$_sCheckedPaymentId = null
	$_aCreditYears = null
	$_sThisTemplate = 'payment.tpl'
	$_blIsOrderStep = true

---

Detailed Description

Includes credit card validation class. Payment manager. Customer payment manager class. Performs payment validation function, etc.

Definition at line 12 of file payment.php.

---

Member Function Documentation

Payment._assignDebitNoteParams

(

)

[protected]

Assign debit note payment values to view data. Loads user debit note payment if available and assigns payment data to $this->_aDynValue

Returns:

null

Definition at line 461 of file payment.php.

Payment._filterDynData

(

)

[protected]

Due to legal reasons probably you are not allowed to store or even handle credit card data. In this case we just delete and forget all submited credit card data from this point. Override this method if you actually want to process credit card data.

Note: You should override this method as setting blStoreCreditCardInfo to true would force storing CC data on shop side (what most often is illegal).

Returns:

null

Definition at line 561 of file payment.php.

Payment._setDefaultEmptyPayment

(

)

[protected]

Set default empty payment. If config param 'blOtherCountryOrder' is on, tries to set 'oxempty' payment to aViewData['oxemptypayment']. On error sets aViewData['payerror'] to -2

Returns:

null

Definition at line 189 of file payment.php.

Payment._setDeprecatedValues	(	&$	aPaymentList,
		$	oBasket = null
	)			[protected]

Calculate payment cost for each payment. Sould be removed later

Parameters:

	array	&$aPaymentList payments array
	oxBasket	$oBasket basket object

Returns:

null

Definition at line 382 of file payment.php.

Payment._unsetPaymentErrors

(

)

[protected]

Unsets payment errors from session

Returns:

null

Definition at line 210 of file payment.php.

Payment.changeshipping

(

)

Changes shipping set to chosen one. Sets basket status to not up-to-date, which later forces to recalculate it

Returns:

null

Definition at line 233 of file payment.php.

Payment.getAllSets

(

)

Template variable getter. Returns all delivery sets

Returns:

array

Definition at line 345 of file payment.php.

Payment.getAllSetsCnt

(

)

Template variable getter. Returns number of delivery sets

Returns:

integer

Definition at line 362 of file payment.php.

Payment.getCheckedPaymentId

(

)

Get checked payment ID. Tries to get checked payment ID from session, if fails, then tries to get payment ID from last order.

Returns:

string

Definition at line 485 of file payment.php.

Payment.getCreditYears

(

)

Template variable getter. Returns array of years for credit cards

Returns:

array

Definition at line 541 of file payment.php.

Payment.getDynValue

(

)

Template variable getter. Returns dyn values

Returns:

array

Definition at line 433 of file payment.php.

Payment.getEmptyPayment

(

)

Template variable getter. Returns payment object "oxempty"

Returns:

object

Definition at line 403 of file payment.php.

Payment.getPaymentCnt

(

)

Template variable getter. Returns payment list count

Returns:

integer

Definition at line 524 of file payment.php.

Payment.getPaymentError

(

)

Template variable getter. Returns error of payments

Returns:

string

Definition at line 413 of file payment.php.

Payment.getPaymentErrorText

(

)

Template variable getter. Returns error text of payments

Returns:

string

Definition at line 423 of file payment.php.

Payment.getPaymentList

(

)

Template variable getter. Returns paymentlist

Returns:

object

Reimplemented from oxUBase.

Definition at line 317 of file payment.php.

Payment.init

(

)

Executes parent method parent.init().

Returns:

null

Reimplemented from oxUBase.

Definition at line 97 of file payment.php.

Payment.render

(

)

Executes parent.render(), checks if this connection secure (if not - redirects to secure payment page), loads user object (if user object loading was not successfull - redirects to start page), loads user delivery/shipping information. According to configuration in admin, user profile data loads delivery sets, and possible payment methods. Returns name of template to render payment._sThisTemplate.

Template variables: allShipsetsCnt, allShipsets, payments, payerror, payerrortext, dynvalue, defpaymentid, basket, deladr

Returns:

string current template file name

Reimplemented from oxUBase.

Definition at line 124 of file payment.php.

Payment.validatePayment

(

)

Validates oxidcreditcard and oxiddebitnote user payment data. Returns false if problems on validating occured. If everything is OK - returns "order" and redirects to payment confirmation page.

Session variables: paymentid, dynvalue, payerror

Returns:

mixed

Definition at line 256 of file payment.php.

---

Member Data Documentation

Payment.$_aAllSets = null [protected]

Definition at line 30 of file payment.php.

Payment.$_aCreditYears = null [protected]

Definition at line 78 of file payment.php.

Payment.$_aDynValue = null [protected]

Definition at line 60 of file payment.php.

Payment.$_blIsOrderStep = true [protected]

Reimplemented from oxUBase.

Definition at line 90 of file payment.php.

Payment.$_iAllSetsCnt = null [protected]

Definition at line 36 of file payment.php.

Payment.$_iPaymentCnt = null [protected]

Definition at line 24 of file payment.php.

Payment.$_oEmptyPayment = null [protected]

Definition at line 42 of file payment.php.

Payment.$_oPaymentList = null [protected]

Definition at line 18 of file payment.php.

Payment.$_sCheckedId = null [protected]

Definition at line 66 of file payment.php.

Payment.$_sCheckedPaymentId = null [protected]

Definition at line 72 of file payment.php.

Payment.$_sPaymentError = null [protected]

Definition at line 48 of file payment.php.

Payment.$_sPaymentErrorText = null [protected]

Definition at line 54 of file payment.php.

Payment.$_sThisTemplate = 'payment.tpl' [protected]

Reimplemented from oxView.

Definition at line 84 of file payment.php.

---

The documentation for this class was generated from the following file:

• views/payment.php