oxPayment Class Reference

Inheritance diagram for oxPayment:
[legend]
Collaboration diagram for oxPayment:
[legend]

List of all members.


Detailed Description

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

Definition at line 8 of file oxpayment.php.


Public Member Functions

 __construct ()
 getGroups ()
 setDynValues ($aDynValues)
 setDynValue ($oKey, $oVal)
 getDynValues ()
 getPaymentValue ($dBaseprice)
 getPaymentPrice ($oBasket)
 getCountries ()
 delete ($sOXID=null)
 isValidPayment ($aDynvalue, $sShopId, $oUser, $dBasketPrice, $sShipSetId)

Protected Attributes

 $_oGroups = null
 $_aCountries = null
 $_sClassName = 'oxpayment'
 $_aDynValues = null

Constructor & Destructor Documentation

oxPayment.__construct (  ) 

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

Reimplemented from oxI18n.

Definition at line 42 of file oxpayment.php.


Member Function Documentation

oxPayment.getGroups (  ) 

Payment groups getter. Returns groups list

Returns:
oxlist

Definition at line 53 of file oxpayment.php.

oxPayment.setDynValues ( aDynValues  ) 

sets the dyn values

Parameters:
array $aDynValues the array of dy values
Returns:
null

Definition at line 77 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 90 of file oxpayment.php.

oxPayment.getDynValues (  ) 

Returns an array of dyn payment values

Returns:
array

Definition at line 100 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 115 of file oxpayment.php.

oxPayment.getPaymentPrice ( oBasket  ) 

Returns price object for current payment applied on basket

Parameters:
oxuserbasket $oBasket session basket
Returns:
oxprice

Definition at line 140 of file oxpayment.php.

oxPayment.getCountries (  ) 

Returns array of country Ids which are assigned to current payment

Returns:
array

Definition at line 162 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 oxBase.

Definition at line 186 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 211 of file oxpayment.php.


Member Data Documentation

oxPayment.$_oGroups = null [protected]

Definition at line 15 of file oxpayment.php.

oxPayment.$_aCountries = null [protected]

Definition at line 23 of file oxpayment.php.

oxPayment.$_sClassName = 'oxpayment' [protected]

Reimplemented from oxI18n.

Definition at line 30 of file oxpayment.php.

oxPayment.$_aDynValues = null [protected]

Definition at line 37 of file oxpayment.php.


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

Generated on Thu Dec 4 12:05:30 2008 for OXID eShop CE by  doxygen 1.5.5