oxPayment Class Reference

Inheritance diagram for oxPayment:

Collaboration diagram for oxPayment:

List of all members.

Public Member Functions
	__construct ()
	setPaymentVatOnTop ($blOnTop)
	getGroups ()
	setDynValues ($aDynValues)
	setDynValue ($oKey, $oVal)
	getDynValues ()
	getPaymentValue ($dBaseprice)
	getBaseBasketPriceForPaymentCostCalc ($oBasket)
	getPaymentPrice ($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 mayment methods, such as assigning to someone, returning value etc.

Definition at line 8 of file oxpayment.php.

---

Constructor & Destructor Documentation

oxPayment.__construct

(

)

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

Reimplemented from oxI18n.

Definition at line 93 of file oxpayment.php.

---

Member Function Documentation

oxPayment.calculate

(

$

oBasket

)

Returns price object for current payment applied on basket

Parameters:

oxuserbasket

$oBasket session basket

Returns:

null

Definition at line 289 of file oxpayment.php.

oxPayment.delete

(

$

sOXID = null

)

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

Parameters:

string

$sOXID Object ID(default null)

Returns:

bool

Reimplemented from oxI18n.

Definition at line 389 of file oxpayment.php.

oxPayment.getBaseBasketPriceForPaymentCostCalc

(

$

oBasket

)

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

Parameters:

oxbasket

$oBasket oxbasket object

Returns:

double

Definition at line 211 of file oxpayment.php.

oxPayment.getCountries

(

)

Returns array of country Ids which are assigned to current payment

Returns:

array

Definition at line 365 of file oxpayment.php.

oxPayment.getDynValues

(

)

Returns an array of dyn payment values

Returns:

array

Definition at line 165 of file oxpayment.php.

oxPayment.getFBruttoPrice

(

)

Returns formated brutto price.

Returns:

string

Definition at line 341 of file oxpayment.php.

oxPayment.getFNettoPrice

(

)

Returns formated netto price.

Returns:

string

Definition at line 329 of file oxpayment.php.

oxPayment.getFPriceVat

(

)

Returns formated vat value.

Returns:

string

Definition at line 353 of file oxpayment.php.

oxPayment.getGroups

(

)

Payment groups getter. Returns groups list

Returns:

oxlist

Definition at line 117 of file oxpayment.php.

oxPayment.getPaymentErrorNumber

(

)

Payment error number getter

Returns:

int

Definition at line 469 of file oxpayment.php.

oxPayment.getPaymentPrice

(

$

oBasket

)

Returns price object for current payment applied on basket

Parameters:

oxuserbasket

$oBasket session basket

Deprecated:

since v5.0.0 (2011-09-27); use calculatePrice() method

Returns:

oxprice

Definition at line 276 of file oxpayment.php.

oxPayment.getPaymentValue

(

$

dBaseprice

)

Returns additional taxes to base article price.

Parameters:

double

$dBaseprice Base article price

Returns:

double

Definition at line 185 of file oxpayment.php.

oxPayment.getPrice

(

)

Returns calculated price.

Returns:

oxprice

Definition at line 319 of file oxpayment.php.

oxPayment.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
	oxuser	$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

Definition at line 415 of file oxpayment.php.

oxPayment.setDynValue	(	$	oKey,
		$	oVal
	)

sets a single dyn value

Parameters:

	mixed	$oKey the key
	mixed	$oVal the value

Returns:

null

Definition at line 155 of file oxpayment.php.

oxPayment.setDynValues

(

$

aDynValues

)

sets the dyn values

Parameters:

array

$aDynValues the array of dy values

Returns:

null

Definition at line 142 of file oxpayment.php.

oxPayment.setPaymentVatOnTop

(

$

blOnTop

)

Payment VAT config setter

Parameters:

bool

$blOnTop Payment vat config

Returns:

null

Definition at line 107 of file oxpayment.php.

---

Member Data Documentation

oxPayment.$_aCountries = null [protected]

Definition at line 53 of file oxpayment.php.

oxPayment.$_aDynValues = null [protected]

Definition at line 67 of file oxpayment.php.

oxPayment.$_blPaymentVatOnTop = false [protected]

Definition at line 81 of file oxpayment.php.

oxPayment.$_iPaymentError = null [protected]

Definition at line 74 of file oxpayment.php.

oxPayment.$_oGroups = null [protected]

Definition at line 45 of file oxpayment.php.

oxPayment.$_oPrice = null [protected]

Definition at line 88 of file oxpayment.php.

oxPayment.$_sClassName = 'oxpayment' [protected]

Reimplemented from oxI18n.

Definition at line 60 of file oxpayment.php.

const oxPayment.PAYMENT_ADDSUMRULE_ALLGOODS = 1

Definition at line 14 of file oxpayment.php.

const oxPayment.PAYMENT_ADDSUMRULE_DISCOUNTS = 2

Definition at line 20 of file oxpayment.php.

const oxPayment.PAYMENT_ADDSUMRULE_GIFTS = 16

Definition at line 38 of file oxpayment.php.

const oxPayment.PAYMENT_ADDSUMRULE_SHIPCOSTS = 8

Definition at line 32 of file oxpayment.php.

const oxPayment.PAYMENT_ADDSUMRULE_VOUCHERS = 4

Definition at line 26 of file oxpayment.php.

---

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

• application/models/oxpayment.php