Payment Class Reference

Inheritance diagram for Payment:

Inheritance graph
[legend]
Collaboration diagram for Payment:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

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

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

Member Function Documentation

Payment.init (  ) 

Executes parent method parent.init().

Returns:
null

Reimplemented from oxUBase.

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.

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

Payment._unsetPaymentErrors (  )  [protected]

Unsets payment errors from session

Returns:
null

Payment.changeshipping (  ) 

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

Returns:
null

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

Payment.getPaymentList (  ) 

Template variable getter. Returns paymentlist

Returns:
object

Reimplemented from oxView.

Payment.getAllSets (  ) 

Template variable getter. Returns all delivery sets

Returns:
array

Payment.getAllSetsCnt (  ) 

Template variable getter. Returns number of delivery sets

Returns:
integer

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

Payment.getEmptyPayment (  ) 

Template variable getter. Returns payment object "oxempty"

Returns:
object

Payment.getPaymentError (  ) 

Template variable getter. Returns error of payments

Returns:
string

Payment.getPaymentErrorText (  ) 

Template variable getter. Returns error text of payments

Returns:
string

Payment.getDynValue (  ) 

Template variable getter. Returns dyn values

Returns:
array

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

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

Payment.getPaymentCnt (  ) 

Template variable getter. Returns payment list count

Returns:
integer

Payment.getCreditYears (  ) 

Template variable getter. Returns array of years for credit cards

Returns:
array


Member Data Documentation

Payment.$_oPaymentList = null [protected]

Payment.$_iPaymentCnt = null [protected]

Payment.$_aAllSets = null [protected]

Payment.$_iAllSetsCnt = null [protected]

Payment.$_oEmptyPayment = null [protected]

Payment.$_sPaymentError = null [protected]

Payment.$_sPaymentErrorText = null [protected]

Payment.$_aDynValue = null [protected]

Payment.$_sCheckedId = null [protected]

Payment.$_sCheckedPaymentId = null [protected]

Payment.$_aCreditYears = null [protected]

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

Reimplemented from oxView.

Payment.$_blIsOrderStep = true [protected]

Reimplemented from oxView.


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

Generated on Wed Oct 29 23:46:58 2008 for OXID eShop CE by  doxygen 1.5.5