OXID eShop CE  4.9.5
 All Classes Files Functions Variables Pages
oxPayment Class Reference
+ Inheritance diagram for oxPayment:
+ Collaboration diagram for oxPayment:

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 Member Functions inherited from oxI18n
 setLanguage ($iLang=null)
 getLanguage ()
 setEnableMultilang ($blEmployMultilanguage)
 isMultilingualField ($sFieldName)
 isMultilang ()
 loadInLang ($iLanguage, $sOxid)
 modifyCacheKey ($sCacheKey, $blOverride=false)
 getAvailableInLangs ()
 getUpdateSqlFieldName ($sField)
- Public Member Functions inherited from oxBase
 getUseSkipSaveFields ()
 setUseSkipSaveFields ($blUseSkipSaveFields)
 __set ($sName, $sValue)
 __get ($sName)
 __isset ($mVar)
 __clone ()
 oxClone ($oObject)
 getUpdateSeo ()
 setUpdateSeo ($blUpdateSeo)
 init ($sTableName=null, $blForceAllFields=false)
 assign ($dbRecord)
 getClassName ()
 getCoreTableName ()
 getId ()
 setId ($sOXID=null)
 setShopId ($iShopId)
 getShopId ()
 getViewName ($blForceCoreTableUsage=null)
 disableLazyLoading ()
 isDerived ()
 setIsDerived ($blVal)
 load ($sOXID)
 isLoaded ()
 buildSelectString ($aWhere=null)
 assignRecord ($sSelect)
 getFieldData ($sFieldName)
 getSelectFields ($blForceCoreTableUsage=null)
 save ()
 allowDerivedUpdate ()
 allowDerivedDelete ()
 exists ($sOXID=null)
 getSqlActiveSnippet ($blForceCoreTable=null)
 beforeUpdate ($sOXID=null)
 onChange ($iAction=null, $sOXID=null)
 setInList ()
 isOx ()
 isReadOnly ()
 setReadOnly ($blReadOnly)
 getFieldNames ()
 addFieldName ($sName)
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

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
- Protected Attributes inherited from oxI18n
 $_sClassName = 'oxI18n'
 $_iLanguage = null
 $_blEmployMultilanguage = true
- Protected Attributes inherited from oxBase
 $_sOXID = null
 $_iShopId = null
 $_blIsSimplyClonable = true
 $_sClassName = 'oxbase'
 $_sCoreTable = null
 $_sViewTable = null
 $_aFieldNames = array('oxid' => 0)
 $_sCacheKey = null
 $_blUseLazyLoading = false
 $_aSkipSaveFields = array('oxtimestamp')
 $_blUseSkipSaveFields = true
 $_sExistKey = 'oxid'
 $_blIsDerived = null
 $_blIsSeoObject = false
 $_blUpdateSeo = true
 $_blReadOnly = false
 $_blIsInList = false
 $_isLoaded = false
 $_aInnerLazyCache = null
 $_blEmployMultilanguage = false

Additional Inherited Members

- Protected Member Functions inherited from oxI18n
 _getFieldStatus ($sFieldName)
 _getNonCachedFieldNames ($blForceFullStructure=false)
 _getFieldLang ($sFieldName)
 _setUpdateSeoOnFieldChange ($sField)
 _getUpdateFieldsForTable ($sTable, $blUseSkipSaveFields=true)
 _getUpdateFields ($blUseSkipSaveFields=true)
 _update ()
 _getLanguageSetTables ($sCoreTableName=null)
 _insert ()
 _getObjectViewName ($sTable, $sShopID=null)
 _getAllFields ($blReturnSimple=false)
 _addField ($sName, $sStatus, $sType=null, $sLength=null)
 _canFieldBeNull ($sFieldName)
- Static Protected Attributes inherited from oxBase
static $_blDisableFieldCaching = array()

Detailed Description

Payment manager. Performs payment 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 99 of file oxpayment.php.

Member Function Documentation

oxPayment::calculate (   $oBasket)

Returns price object for current payment applied on basket

Parameters
oxUserBasket$oBasketsession basket

Definition at line 277 of file oxpayment.php.

oxPayment::delete (   $sOxId = null)

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

Parameters
string$sOxIdObject ID(default null)
Returns
bool

Reimplemented from oxI18n.

Definition at line 374 of file oxpayment.php.

oxPayment::getBaseBasketPriceForPaymentCostCalc (   $oBasket)

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

Parameters
oxBasket$oBasketoxBasket object
Returns
double

Definition at line 212 of file oxpayment.php.

oxPayment::getCountries ( )

Returns array of country Ids which are assigned to current payment

Returns
array

Definition at line 354 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 formatted brutto price.

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

Definition at line 328 of file oxpayment.php.

oxPayment::getFNettoPrice ( )

Returns formatted netto price.

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

Definition at line 314 of file oxpayment.php.

oxPayment::getFPriceVat ( )

Returns formatted vat value.

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

Definition at line 342 of file oxpayment.php.

oxPayment::getGroups ( )

Payment groups getter. Returns groups list

Returns
oxList

Definition at line 121 of file oxpayment.php.

oxPayment::getPaymentErrorNumber ( )

Payment error number getter

Returns
int

Definition at line 464 of file oxpayment.php.

oxPayment::getPaymentValue (   $dBasePrice)

Returns additional taxes to base article price.

Parameters
double$dBasePriceBase article price
Returns
double

Definition at line 186 of file oxpayment.php.

oxPayment::getPrice ( )

Returns calculated price.

Returns
oxPrice

Definition at line 302 of file oxpayment.php.

oxPayment::isValidPayment (   $aDynValue,
  $sShopId,
  $oUser,
  $dBasketPrice,
  $sShipSetId 
)

Function checks if loaded payment is valid to current basket

Parameters
array$aDynValuedynamical value (in this case oxidcreditcard and oxiddebitnote are checked only)
string$sShopIdid of current shop
oxUser$oUserthe current user
double$dBasketPricethe current basket price (oBasket->dPrice)
string$sShipSetIdthe current ship set
Returns
bool true if payment is valid

Definition at line 401 of file oxpayment.php.

oxPayment::setDynValue (   $oKey,
  $oVal 
)

Sets a single dyn value

Parameters
mixed$oKeythe key
mixed$oValthe value

Definition at line 155 of file oxpayment.php.

oxPayment::setDynValues (   $aDynValues)

sets the dyn values

Parameters
array$aDynValuesthe array of dy values

Definition at line 144 of file oxpayment.php.

oxPayment::setPaymentVatOnTop (   $blOnTop)

Payment VAT config setter

Parameters
bool$blOnTopPayment vat config

Definition at line 111 of file oxpayment.php.

Member Data Documentation

oxPayment::$_aCountries = null
protected

Definition at line 59 of file oxpayment.php.

oxPayment::$_aDynValues = null
protected

Definition at line 73 of file oxpayment.php.

oxPayment::$_blPaymentVatOnTop = false
protected

Definition at line 87 of file oxpayment.php.

oxPayment::$_iPaymentError = null
protected

Definition at line 80 of file oxpayment.php.

oxPayment::$_oGroups = null
protected

Definition at line 51 of file oxpayment.php.

oxPayment::$_oPrice = null
protected

Definition at line 94 of file oxpayment.php.

oxPayment::$_sClassName = 'oxpayment'
protected

Definition at line 66 of file oxpayment.php.

const oxPayment::PAYMENT_ADDSUMRULE_ALLGOODS = 1

Definition at line 16 of file oxpayment.php.

const oxPayment::PAYMENT_ADDSUMRULE_DISCOUNTS = 2

Definition at line 23 of file oxpayment.php.

const oxPayment::PAYMENT_ADDSUMRULE_GIFTS = 16

Definition at line 44 of file oxpayment.php.

const oxPayment::PAYMENT_ADDSUMRULE_SHIPCOSTS = 8

Definition at line 37 of file oxpayment.php.

const oxPayment::PAYMENT_ADDSUMRULE_VOUCHERS = 4

Definition at line 30 of file oxpayment.php.


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