OxidEsales\EshopCommunity\Application\Model\Payment Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\Payment:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\Payment:

Public Member Functions
	__construct ()
	setPaymentVatOnTop ($blOnTop)
	getGroups ()
	setDynValues ($aDynValues)
	setDynValue ($oKey, $oVal)
	getDynValues ()
	getPaymentValue ($dBasePrice)
	getBaseBasketPriceForPaymentCostCalc ($oBasket)
	calculate ($oBasket)
	getPrice ()
	getFNettoPrice ()
	getFBruttoPrice ()
	getFPriceVat ()
	getCountries ()
	delete ($sOxId=null)
	isValidPayment ($aDynValue, $sShopId, $oUser, $dBasketPrice, $sShipSetId)
	getPaymentErrorNumber ()

Public Attributes
const	PAYMENT_ADDSUMRULE_ALLGOODS = 1
const	PAYMENT_ADDSUMRULE_DISCOUNTS = 2
const	PAYMENT_ADDSUMRULE_VOUCHERS = 4
const	PAYMENT_ADDSUMRULE_SHIPCOSTS = 8
const	PAYMENT_ADDSUMRULE_GIFTS = 16

Protected Attributes
	$_oGroups = null
	$_aCountries = null
	$_sClassName = 'oxpayment'
	$_aDynValues = null
	$_iPaymentError = null
	$_blPaymentVatOnTop = false
	$_oPrice = null

Detailed Description

Payment manager. Performs payment methods, such as assigning to someone, returning value etc.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\Payment::__construct

(

)

Class constructor, initiates parent constructor (parent::oxI18n()).

Member Function Documentation

calculate()

OxidEsales\EshopCommunity\Application\Model\Payment::calculate

(

$oBasket

)

Returns price object for current payment applied on basket

Parameters

\OxidEsales\Eshop\Application\Model\UserBasket

$oBasket

session basket

delete()

OxidEsales\EshopCommunity\Application\Model\Payment::delete

(

$sOxId = null

)

Delete this object from the database, returns true on success.

Parameters

string

$sOxId

Object ID(default null)

Returns

bool

getBaseBasketPriceForPaymentCostCalc()

OxidEsales\EshopCommunity\Application\Model\Payment::getBaseBasketPriceForPaymentCostCalc

(

$oBasket

)

Returns base basket price for payment cost calculations. Price depends on payment setup (payment administration)

Parameters

\OxidEsales\Eshop\Application\Model\Basket

$oBasket

oxBasket object

Returns

double

getCountries()

OxidEsales\EshopCommunity\Application\Model\Payment::getCountries

(

)

Returns array of country Ids which are assigned to current payment

Returns

array

getDynValues()

OxidEsales\EshopCommunity\Application\Model\Payment::getDynValues

(

)

Returns an array of dyn payment values

Returns

array

getFBruttoPrice()

OxidEsales\EshopCommunity\Application\Model\Payment::getFBruttoPrice

(

)

Returns formatted brutto price.

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

getFNettoPrice()

OxidEsales\EshopCommunity\Application\Model\Payment::getFNettoPrice

(

)

Returns formatted netto price.

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

getFPriceVat()

OxidEsales\EshopCommunity\Application\Model\Payment::getFPriceVat

(

)

Returns formatted vat value.

Deprecated:

in v4.8/5.1 on 2013-10-14; for formatting use oxPrice smarty plugin

Returns

string

getGroups()

OxidEsales\EshopCommunity\Application\Model\Payment::getGroups

(

)

Payment groups getter. Returns groups list

Returns

oxList

getPaymentErrorNumber()

OxidEsales\EshopCommunity\Application\Model\Payment::getPaymentErrorNumber

(

)

Payment error number getter

Returns

int

getPaymentValue()

OxidEsales\EshopCommunity\Application\Model\Payment::getPaymentValue

(

$dBasePrice

)

Returns additional taxes to base article price.

Parameters

double

$dBasePrice

Base article price

Returns

double

getPrice()

OxidEsales\EshopCommunity\Application\Model\Payment::getPrice

(

)

Returns calculated price.

Returns

oxPrice

isValidPayment()

OxidEsales\EshopCommunity\Application\Model\Payment::isValidPayment	(		$aDynValue,
			$sShopId,
			$oUser,
			$dBasketPrice,
			$sShipSetId
	)

Function checks if loaded payment is valid to current basket

Parameters

array	$aDynValue	dynamical value (in this case oxidcreditcard and oxiddebitnote are checked only)
string	$sShopId	id of current shop
\OxidEsales\Eshop\Application\Model\User	$oUser	the current user
double	$dBasketPrice	the current basket price (oBasket->dPrice)
string	$sShipSetId	the current ship set

Returns

bool true if payment is valid

setDynValue()

OxidEsales\EshopCommunity\Application\Model\Payment::setDynValue	(		$oKey,
			$oVal
	)

Sets a single dyn value

Parameters

mixed	$oKey	the key
mixed	$oVal	the value

setDynValues()

OxidEsales\EshopCommunity\Application\Model\Payment::setDynValues

(

$aDynValues

)

sets the dyn values

Parameters

array

$aDynValues

the array of dy values

setPaymentVatOnTop()

OxidEsales\EshopCommunity\Application\Model\Payment::setPaymentVatOnTop

(

$blOnTop

)

Payment VAT config setter

Parameters

bool

$blOnTop

Payment vat config

Member Data Documentation

$_aCountries

OxidEsales\EshopCommunity\Application\Model\Payment::$_aCountries = null

protected

$_aDynValues

OxidEsales\EshopCommunity\Application\Model\Payment::$_aDynValues = null

protected

$_blPaymentVatOnTop

OxidEsales\EshopCommunity\Application\Model\Payment::$_blPaymentVatOnTop = false

protected

$_iPaymentError

OxidEsales\EshopCommunity\Application\Model\Payment::$_iPaymentError = null

protected

$_oGroups

OxidEsales\EshopCommunity\Application\Model\Payment::$_oGroups = null

protected

$_oPrice

OxidEsales\EshopCommunity\Application\Model\Payment::$_oPrice = null

protected

$_sClassName

OxidEsales\EshopCommunity\Application\Model\Payment::$_sClassName = 'oxpayment'

protected

PAYMENT_ADDSUMRULE_ALLGOODS

const OxidEsales\EshopCommunity\Application\Model\Payment::PAYMENT_ADDSUMRULE_ALLGOODS = 1

PAYMENT_ADDSUMRULE_DISCOUNTS

const OxidEsales\EshopCommunity\Application\Model\Payment::PAYMENT_ADDSUMRULE_DISCOUNTS = 2

PAYMENT_ADDSUMRULE_GIFTS

const OxidEsales\EshopCommunity\Application\Model\Payment::PAYMENT_ADDSUMRULE_GIFTS = 16

PAYMENT_ADDSUMRULE_SHIPCOSTS

const OxidEsales\EshopCommunity\Application\Model\Payment::PAYMENT_ADDSUMRULE_SHIPCOSTS = 8

PAYMENT_ADDSUMRULE_VOUCHERS

const OxidEsales\EshopCommunity\Application\Model\Payment::PAYMENT_ADDSUMRULE_VOUCHERS = 4

---

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

• /oxideshop-ce/source/Application/Model/Payment.php