OXID eShop CE  4.8.12
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Payment Class Reference
+ Inheritance diagram for Payment:
+ Collaboration diagram for Payment:

Public Member Functions

 init ()
 render ()
 changeshipping ()
 validatePayment ()
 getPaymentList ()
 getAllSets ()
 getAllSetsCnt ()
 getEmptyPayment ()
 getPaymentError ()
 getDynDataFiltered ()
 getPaymentErrorText ()
 isOldDebitValidationEnabled ()
 getDynValue ()
 getCheckedPaymentId ()
 getPaymentCnt ()
 getCreditYears ()
 getTsProtections ()
 getCheckedTsProductId ()
 getBreadCrumb ()
 isPaymentVatSplitted ()
- Public Member Functions inherited from oxUBase
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 getListType ()
 getListDisplayType ()
 getCustomListDisplayType ()
 setListType ($sType)
 loadCurrency ()
 dontShowEmptyCategories ()
 showCategoryArticlesCount ()
 isLanguageLoaded ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 getSortOrderByParameterName ()
 getSortOrderParameterName ()
 getSortIdent ()
 getDefaultSorting ()
 getUserSelectedSorting ()
 getSavedSorting ($sSortIdent)
 setListOrderBy ($sColumn)
 setListOrderDirection ($sDirection)
 prepareSortColumns ()
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 isSortingActive ()
 getMenueList ()
 setMenueList ($aMenue)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getDynUrlParams ()
 getLink ($iLang=null)
 getCanonicalUrl ()
 getSimilarRecommListIds ()
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigation ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getAddUrlParams ()
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getSearchCatTree ()
 setSearchCatTree ($aTree)
 getCatMoreUrl ()
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 getLastProducts ()
 getNewBasketItemMsgType ()
 isActive ($sName)
 isFbWidgetVisible ()
 isEnabledDownloadableFiles ()
 showRememberMe ()
 isVatIncluded ()
 isPriceCalculated ()
 showTags ()
 getWishlistName ()
 getWidgetLink ()
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 addTplParam ($sPara, $sValue)
 getBelboonParam ()
 getViewConfig ()
 getTemplateName ()
 setTemplateName ($sTemplate)
 setClassName ($sClassName)
 getClassName ()
 setFncName ($sFncName)
 getFncName ()
 setViewData ($aViewData=null)
 getViewData ()
 getViewDataElement ($sParamId=null)
 setClassLocation ($sClassLocation=null)
 getClassLocation ()
 setThisAction ($sThisAction=null)
 getThisAction ()
 setParent ($oParent=null)
 getParent ()
 setIsComponent ($blIsComponent=null)
 getIsComponent ()
 executeFunction ($sFunction)
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isBetaVersion ()
 isRCVersion ()
 showBetaNote ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()
 getSidForWidget ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _setDefaultEmptyPayment ()
 _unsetPaymentErrors ()
 _setValues (&$aPaymentList, $oBasket=null)
 _assignDebitNoteParams ()
 _checkArrValuesEmpty ($aData, $aKeys)
 _filterDynData ()
- Protected Member Functions inherited from oxUBase
 _getComponentNames ()
 _processRequest ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _getSeoObjectId ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blRemoveDuplicatedWords=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _removeDuplicatedWords ($aInput, $aSkipTags=array())
 _getSubject ($iLang)
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _canRedirect ()
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

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
- Protected Attributes inherited from oxUBase
 $_blFbWidgetsOn = null
 $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
 $_oaComponents = array()
 $_blIsOrderStep = false
 $_sListType = null
 $_aListDisplayTypes = array( 'grid', 'line', 'infogrid' )
 $_sListDisplayType = null
 $_sCustomListDisplayType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blLoadCurrency = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blEnabledPrivateSales = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_blActiveSorting = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_blLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array( 'fnc', 'stoken', 'force_sid', 'force_admin_sid' )
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_aSearchCatTree = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false
 $_aMustFillFields = null
 $_blShowTagCloud = true
 $_blRootCatChanged = false
 $_aInvoiceAddress = null
 $_aDeliveryAddress = null
 $_sActiveUsername = null
 $_blLoadComponents = true
 $_aSortColumns = null
- Protected Attributes inherited from oxView
 $_aViewData = array()
 $_sClassLocation = null
 $_sThisAction = null
 $_oParent = null
 $_blIsComponent = false
 $_sThisTemplate = null
 $_sViewId = null
 $_sClass = null
 $_sFnc = null
 $_sTrustedShopId = null
 $_sTSExcellenceId = null
 $_sCharSet = null
 $_sVersion = null
 $_blDemoVersion = null
 $_blDemoShop = null
 $_iNewsStatus = null
 $_sShopLogo = null
 $_sCategoryId = null
 $_oClickCat = null
 $_blIsCallForCache = false
 $_oViewConf = null

Additional Inherited Members

- Static Protected Attributes inherited from oxUBase
static $_aCollectedComponentNames = null

Detailed Description

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

Definition at line 7 of file payment.php.

Member Function Documentation

Payment::_assignDebitNoteParams ( )
protected

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

Returns
null

Definition at line 492 of file payment.php.

Payment::_checkArrValuesEmpty (   $aData,
  $aKeys 
)
protected

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

Parameters
array$aDataarray of data to check
array$aKeysarray of array indexes
Returns
bool

Definition at line 593 of file payment.php.

Payment::_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

Definition at line 619 of file payment.php.

Payment::_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

Returns
null

Definition at line 180 of file payment.php.

Payment::_setValues ( &  $aPaymentList,
  $oBasket = null 
)
protected

Calculate payment cost for each payment. Sould be removed later

Parameters
array&$aPaymentListpayments array
oxBasket$oBasketbasket object
Returns
null

Definition at line 396 of file payment.php.

Payment::_unsetPaymentErrors ( )
protected

Unsets payment errors from session

Returns
null

Definition at line 201 of file payment.php.

Payment::changeshipping ( )

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

Returns
null

Definition at line 227 of file payment.php.

Payment::getAllSets ( )

Template variable getter. Returns all delivery sets

Returns
array

Definition at line 359 of file payment.php.

Payment::getAllSetsCnt ( )

Template variable getter. Returns number of delivery sets

Returns
integer

Definition at line 376 of file payment.php.

Payment::getBreadCrumb ( )

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

Returns
array

Reimplemented from oxUBase.

Definition at line 714 of file payment.php.

Payment::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

Definition at line 516 of file payment.php.

Payment::getCheckedTsProductId ( )

Template variable getter. Returns payment list count

Returns
integer

Definition at line 698 of file payment.php.

Payment::getCreditYears ( )

Template variable getter. Returns array of years for credit cards

Returns
array

Definition at line 575 of file payment.php.

Payment::getDynDataFiltered ( )

Dyndata filter marker getter. Returns if dyndata is filtered

Returns
boolean

Definition at line 434 of file payment.php.

Payment::getDynValue ( )

Template variable getter. Returns dyn values

Returns
array

Definition at line 464 of file payment.php.

Payment::getEmptyPayment ( )

Template variable getter. Returns payment object "oxempty"

Returns
object

Definition at line 414 of file payment.php.

Payment::getPaymentCnt ( )

Template variable getter. Returns payment list count

Returns
integer

Definition at line 558 of file payment.php.

Payment::getPaymentError ( )

Template variable getter. Returns error of payments

Returns
string

Definition at line 424 of file payment.php.

Payment::getPaymentErrorText ( )

Template variable getter. Returns error text of payments

Returns
string

Definition at line 444 of file payment.php.

Payment::getPaymentList ( )

Template variable getter. Returns paymentlist

Returns
object

Reimplemented from oxUBase.

Definition at line 328 of file payment.php.

Payment::getTsProtections ( )

Template variable getter. Returns payment list count

Returns
integer

Definition at line 679 of file payment.php.

Payment::init ( )

Executes parent method parent::init().

Returns
null

Reimplemented from oxUBase.

Definition at line 105 of file payment.php.

Payment::isOldDebitValidationEnabled ( )

Return if old style bank code is supported.

Returns
bool

Definition at line 454 of file payment.php.

Payment::isPaymentVatSplitted ( )

Retuns config true if Vat is splitted

Returns
array

Definition at line 733 of file payment.php.

Payment::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

Reimplemented from oxUBase.

Definition at line 122 of file payment.php.

Payment::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

Definition at line 248 of file payment.php.

Member Data Documentation

Payment::$_aAllSets = null
protected

Definition at line 25 of file payment.php.

Payment::$_aCreditYears = null
protected

Definition at line 73 of file payment.php.

Payment::$_aDynValue = null
protected

Definition at line 55 of file payment.php.

Payment::$_aTsProducts = null
protected

Definition at line 91 of file payment.php.

Payment::$_blDynDataFiltered = false
protected

Definition at line 97 of file payment.php.

Payment::$_blIsOrderStep = true
protected

Definition at line 85 of file payment.php.

Payment::$_iAllSetsCnt = null
protected

Definition at line 31 of file payment.php.

Payment::$_iPaymentCnt = null
protected

Definition at line 19 of file payment.php.

Payment::$_oEmptyPayment = null
protected

Definition at line 37 of file payment.php.

Payment::$_oPaymentList = null
protected

Definition at line 13 of file payment.php.

Payment::$_sCheckedId = null
protected

Definition at line 61 of file payment.php.

Payment::$_sCheckedPaymentId = null
protected

Definition at line 67 of file payment.php.

Payment::$_sPaymentError = null
protected

Definition at line 43 of file payment.php.

Payment::$_sPaymentErrorText = null
protected

Definition at line 49 of file payment.php.

Payment::$_sThisTemplate = 'page/checkout/payment.tpl'
protected

Definition at line 79 of file payment.php.

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