oxpayment.php

Go to the documentation of this file.

<?php

class oxPayment extends oxI18n
{

    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 $_oGroups = null;

    protected $_aCountries = null;

    protected $_sClassName = 'oxpayment';

    protected $_aDynValues = null;

    protected $_iPaymentError = null;

    protected $_blPaymentVatOnTop = false;

    protected $_oPrice = null;

    public function __construct()
    {
        $this->setPaymentVatOnTop($this->getConfig()->getConfigParam('blPaymentVatOnTop'));
        parent::__construct();
        $this->init('oxpayments');
    }

    public function setPaymentVatOnTop($blOnTop)
    {
        $this->_blPaymentVatOnTop = $blOnTop;
    }

    public function getGroups()
    {
        if ($this->_oGroups == null && ($sOxid = $this->getId())) {

            // user groups
            $this->_oGroups = oxNew('oxlist', 'oxgroups');
            $sViewName = getViewName("oxgroups", $this->getLanguage());

            // performance
            $sSelect = "select {$sViewName}.* from {$sViewName}, oxobject2group
                        where oxobject2group.oxobjectid = '{$sOxid}'
                        and oxobject2group.oxgroupsid={$sViewName}.oxid ";
            $this->_oGroups->selectString($sSelect);
        }

        return $this->_oGroups;
    }

    public function setDynValues($aDynValues)
    {
        $this->_aDynValues = $aDynValues;
    }

    public function setDynValue($oKey, $oVal)
    {
        $this->_aDynValues[$oKey] = $oVal;
    }

    public function getDynValues()
    {
        if (!$this->_aDynValues) {
            $sRawDynValue = null;
            if (is_object($this->oxpayments__oxvaldesc)) {
                $sRawDynValue = $this->oxpayments__oxvaldesc->getRawValue();
            }

            $this->_aDynValues = oxRegistry::getUtils()->assignValuesFromText($sRawDynValue);
        }

        return $this->_aDynValues;
    }

    public function getPaymentValue($dBasePrice)
    {
        $dRet = 0;

        if ($this->oxpayments__oxaddsumtype->value == "%") {
            $dRet = $dBasePrice * $this->oxpayments__oxaddsum->value / 100;
        } else {
            $oCur = $this->getConfig()->getActShopCurrencyObject();
            $dRet = $this->oxpayments__oxaddsum->value * $oCur->rate;
        }

        if (($dRet * -1) > $dBasePrice) {
            $dRet = $dBasePrice;
        }

        return $dRet;
    }

    public function getBaseBasketPriceForPaymentCostCalc($oBasket)
    {
        $dBasketPrice = 0;
        $iRules = $this->oxpayments__oxaddsumrules->value;

        // products brutto price
        if (!$iRules || ($iRules & self::PAYMENT_ADDSUMRULE_ALLGOODS)) {
            $dBasketPrice += $oBasket->getProductsPrice()->getSum($oBasket->isCalculationModeNetto());
        }

        // discounts
        if ((!$iRules || ($iRules & self::PAYMENT_ADDSUMRULE_DISCOUNTS)) &&
            ($oCosts = $oBasket->getTotalDiscount())
        ) {
            $dBasketPrice -= $oCosts->getPrice();
        }

        // vouchers
        if (!$iRules || ($iRules & self::PAYMENT_ADDSUMRULE_VOUCHERS)) {
            $dBasketPrice -= $oBasket->getVoucherDiscValue();
        }

        // delivery
        if ((!$iRules || ($iRules & self::PAYMENT_ADDSUMRULE_SHIPCOSTS)) &&
            ($oCosts = $oBasket->getCosts('oxdelivery'))
        ) {
            if ($oBasket->isCalculationModeNetto()) {
                $dBasketPrice += $oCosts->getNettoPrice();
            } else {
                $dBasketPrice += $oCosts->getBruttoPrice();
            }

        }

        // wrapping
        if (($iRules & self::PAYMENT_ADDSUMRULE_GIFTS) &&
            ($oCosts = $oBasket->getCosts('oxwrapping'))
        ) {
            if ($oBasket->isCalculationModeNetto()) {
                $dBasketPrice += $oCosts->getNettoPrice();
            } else {
                $dBasketPrice += $oCosts->getBruttoPrice();
            }
        }

        // gift card
        if (($iRules & self::PAYMENT_ADDSUMRULE_GIFTS) &&
            ($oCosts = $oBasket->getCosts('oxgiftcard'))
        ) {

            if ($oBasket->isCalculationModeNetto()) {
                $dBasketPrice += $oCosts->getNettoPrice();
            } else {
                $dBasketPrice += $oCosts->getBruttoPrice();
            }
        }

        return $dBasketPrice;
    }

    public function calculate($oBasket)
    {
        //getting basket price with applied discounts and vouchers
        $dPrice = $this->getPaymentValue($this->getBaseBasketPriceForPaymentCostCalc($oBasket));

        if ($dPrice) {
            // calculating total price
            $oPrice = oxNew('oxPrice');
            $oPrice->setNettoMode($this->_blPaymentVatOnTop);

            $oPrice->setPrice($dPrice);
            if ($dPrice > 0) {
                $oPrice->setVat($oBasket->getAdditionalServicesVatPercent());
            }

            $this->_oPrice = $oPrice;
        } else {
            // no payment costs
            $oPrice = oxNew('oxPrice');
            $oPrice->setPrice(0);
            $this->_oPrice = $oPrice;
        }

    }

    public function getPrice()
    {
        return $this->_oPrice;
    }

    public function getFNettoPrice()
    {
        if ($this->getPrice()) {
            return oxRegistry::getLang()->formatCurrency($this->getPrice()->getNettoPrice());
        }
    }

    public function getFBruttoPrice()
    {
        if ($this->getPrice()) {
            return oxRegistry::getLang()->formatCurrency($this->getPrice()->getBruttoPrice());
        }
    }

    public function getFPriceVat()
    {
        if ($this->getPrice()) {
            return oxRegistry::getLang()->formatCurrency($this->getPrice()->getVatValue());
        }
    }

    public function getCountries()
    {
        if ($this->_aCountries === null) {
            $oDb = oxDb::getDb();
            $this->_aCountries = array();
            $sSelect = 'select oxobjectid from oxobject2payment where oxpaymentid=' . $oDb->quote($this->getId()) . ' and oxtype = "oxcountry" ';
            $rs = $oDb->getCol($sSelect);
            $this->_aCountries = $rs;
        }

        return $this->_aCountries;
    }

    public function delete($sOxId = null)
    {
        if (parent::delete($sOxId)) {

            $sOxId = $sOxId ? $sOxId : $this->getId();
            $oDb = oxDb::getDb();

            // deleting payment related data
            $rs = $oDb->execute("delete from oxobject2payment where oxpaymentid = " . $oDb->quote($sOxId));

            return $rs->EOF;
        }

        return false;
    }

    public function isValidPayment($aDynValue, $sShopId, $oUser, $dBasketPrice, $sShipSetId)
    {
        $myConfig = $this->getConfig();
        if ($this->oxpayments__oxid->value == 'oxempty') {
            // inactive or blOtherCountryOrder is off
            if (!$this->oxpayments__oxactive->value || !$myConfig->getConfigParam("blOtherCountryOrder")) {
                $this->_iPaymentError = -2;

                return false;
            }
            if (count(
                oxRegistry::get("oxDeliverySetList")
                    ->getDeliverySetList(
                        $oUser,
                        $oUser->getActiveCountry()
                    )
            )
            ) {
                $this->_iPaymentError = -3;

                return false;
            }

            return true;
        }

        $mxValidationResult = oxRegistry::get("oxInputValidator")->validatePaymentInputData($this->oxpayments__oxid->value, $aDynValue);

        if (is_integer($mxValidationResult)) {
            $this->_iPaymentError = $mxValidationResult;

            return false;
        } elseif ($mxValidationResult === false) {
            $this->_iPaymentError = 1;

            return false;
        }

        $oCur = $myConfig->getActShopCurrencyObject();
        $dBasketPrice = $dBasketPrice / $oCur->rate;

        if ($sShipSetId) {
            $aPaymentList = oxRegistry::get("oxPaymentList")->getPaymentList($sShipSetId, $dBasketPrice, $oUser);

            if (!array_key_exists($this->getId(), $aPaymentList)) {
                $this->_iPaymentError = -3;

                return false;
            }
        } else {
            $this->_iPaymentError = -2;

            return false;
        }

        return true;
    }

    public function getPaymentErrorNumber()
    {
        return $this->_iPaymentError;
    }
}