OxidEsales\EshopCommunity\Application\Controller\PaymentController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\PaymentController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\PaymentController:

Public Member Functions
	init ()
	render ()
	changeshipping ()
	validatePayment ()
	getPaymentList ()
	getAllSets ()
	getAllSetsCnt ()
	getEmptyPayment ()
	getPaymentError ()
	getDynDataFiltered ()
	getPaymentErrorText ()
	isOldDebitValidationEnabled ()
	getDynValue ()
	getCheckedPaymentId ()
	getPaymentCnt ()
	getCreditYears ()
	getBreadCrumb ()
	isPaymentVatSplitted ()

Protected Member Functions
	_setDefaultEmptyPayment ()
	_unsetPaymentErrors ()
	_setValues (& $aPaymentList, $oBasket=null)
	_assignDebitNoteParams ()
	_checkArrValuesEmpty ($aData, $aKeys)
	_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 = 'page/checkout/payment.tpl'
	$_blIsOrderStep = true
	$_aTsProducts = null
	$_blDynDataFiltered = false

Detailed Description

Payment manager. Customer payment manager class. Performs payment validation function, etc.

Member Function Documentation

_assignDebitNoteParams()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::_assignDebitNoteParams ( )

protected

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

_checkArrValuesEmpty()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::_checkArrValuesEmpty (   $aData,   $aKeys  )

protected

Function to check if array values are empty againts given array keys

Parameters

array	$aData	array of data to check
array	$aKeys	array of array indexes

Returns

bool

_filterDynData()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::_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

_setDefaultEmptyPayment()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::_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

_setValues()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::_setValues ( &  $aPaymentList,   $oBasket = null  )

protected

Calculate payment cost for each payment. Sould be removed later

Parameters

array	$aPaymentList	payments array
\OxidEsales\Eshop\Application\Model\Basket	$oBasket	basket object

_unsetPaymentErrors()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::_unsetPaymentErrors ( )

protected

Unsets payment errors from session

changeshipping()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::changeshipping

(

)

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

getAllSets()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getAllSets

(

)

Template variable getter. Returns all delivery sets

Returns

array

getAllSetsCnt()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getAllSetsCnt

(

)

Template variable getter. Returns number of delivery sets

Returns

integer

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns

array

getCheckedPaymentId()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::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

getCreditYears()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getCreditYears

(

)

Template variable getter. Returns array of years for credit cards

Returns

array

getDynDataFiltered()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getDynDataFiltered

(

)

Dyndata filter marker getter. Returns if dyndata is filtered

Returns

boolean

getDynValue()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getDynValue

(

)

Template variable getter. Returns dyn values

Returns

array

getEmptyPayment()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getEmptyPayment

(

)

Template variable getter. Returns payment object "oxempty"

Returns

object

getPaymentCnt()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getPaymentCnt

(

)

Template variable getter. Returns payment list count

Returns

integer

getPaymentError()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getPaymentError

(

)

Template variable getter. Returns error of payments

Returns

string

getPaymentErrorText()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getPaymentErrorText

(

)

Template variable getter. Returns error text of payments

Returns

string

getPaymentList()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::getPaymentList

(

)

Template variable getter. Returns paymentlist

Returns

object

init()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::init

(

)

Executes parent method parent::init().

isOldDebitValidationEnabled()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::isOldDebitValidationEnabled

(

)

Return if old style bank code is supported.

Returns

bool

isPaymentVatSplitted()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::isPaymentVatSplitted

(

)

Retuns config true if Vat is splitted

Returns

array

render()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::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.

Returns

string current template file name

validatePayment()

OxidEsales\EshopCommunity\Application\Controller\PaymentController::validatePayment

(

)

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

Session variables: paymentid, dynvalue, payerror

Returns

mixed

Member Data Documentation

$_aAllSets

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_aAllSets = null

protected

$_aCreditYears

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_aCreditYears = null

protected

$_aDynValue

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_aDynValue = null

protected

$_aTsProducts

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_aTsProducts = null

protected

$_blDynDataFiltered

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_blDynDataFiltered = false

protected

$_blIsOrderStep

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_blIsOrderStep = true

protected

$_iAllSetsCnt

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_iAllSetsCnt = null

protected

$_iPaymentCnt

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_iPaymentCnt = null

protected

$_oEmptyPayment

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_oEmptyPayment = null

protected

$_oPaymentList

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_oPaymentList = null

protected

$_sCheckedId

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_sCheckedId = null

protected

$_sCheckedPaymentId

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_sCheckedPaymentId = null

protected

$_sPaymentError

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_sPaymentError = null

protected

$_sPaymentErrorText

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_sPaymentErrorText = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\PaymentController::$_sThisTemplate = 'page/checkout/payment.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Controller/PaymentController.php