oxvoucher.php

Go to the documentation of this file.

<?php

class oxVoucher extends oxBase
{

    protected $_oSerie = null;

    protected $_blDisableShopCheck = true;

    protected $_sClassName = 'oxvoucher';

    public function __construct()
    {
        parent::__construct();
        $this->init( 'oxvouchers' );
    }

    public function getVoucherByNr( $sVoucherNr, $aVouchers = array(), $blCheckavalability = false )
    {
        $oRet = null;
        if ( !is_null( $sVoucherNr ) ) {

            $sViewName = $this->getViewName();
            $sSeriesViewName = getViewName( 'oxvoucherseries' );

            $sQ  = "select {$sViewName}.* from {$sViewName}, {$sSeriesViewName} where
                        {$sSeriesViewName}.oxid = {$sViewName}.oxvoucherserieid and
                        {$sViewName}.oxvouchernr = " . oxDb::getDb()->quote( $sVoucherNr ) . " and ";

            if ( is_array( $aVouchers ) ) {
                foreach ( $aVouchers as $sVoucherId => $sSkipVoucherNr ) {
                    $sQ .= "{$sViewName}.oxid != " . oxDb::getDb()->quote( $sVoucherId ) . " and ";
                }
            }
            $sQ .= "( {$sViewName}.oxorderid is NULL || {$sViewName}.oxorderid = '' ) ";

            //voucher timeout for 3 hours
            if ( $blCheckavalability ) {
                $iTime = time() - 3600 * 3;
                $sQ .= " and {$sViewName}.oxreserved < '{$iTime}' ";
            }

            $sQ .= " limit 1";

            if ( ! ( $oRet = $this->assignRecord( $sQ ) ) ) {
                $oEx = oxNew( 'oxVoucherException' );
                $oEx->setMessage( 'EXCEPTION_VOUCHER_NOVOUCHER' );
                $oEx->setVoucherNr( $sVoucherNr );
                throw $oEx;
            }
        }

        return $oRet;
    }

    public function markAsUsed( $sOrderId, $sUserId, $dDiscount )
    {
        //saving oxreserved field
        if ( $this->oxvouchers__oxid->value ) {
            $this->oxvouchers__oxorderid->setValue($sOrderId);
            $this->oxvouchers__oxuserid->setValue($sUserId);
            $this->oxvouchers__oxdiscount->setValue($dDiscount);
            $this->oxvouchers__oxdateused->setValue(date( "Y-m-d", oxUtilsDate::getInstance()->getTime() ));
            $this->save();
        }
    }

    public function markAsReserved()
    {
        //saving oxreserved field
        $sVoucherID = $this->oxvouchers__oxid->value;

        if ( $sVoucherID ) {
            $sQ = "update oxvouchers set oxreserved = " . time() . " where oxid = " . oxDb::getDb()->quote( $sVoucherID );
            oxDb::getDb()->Execute( $sQ );
        }
    }

    public function unMarkAsReserved()
    {
        //saving oxreserved field
        $sVoucherID = $this->oxvouchers__oxid->value;

        if ( $sVoucherID ) {
            $sQ = "update oxvouchers set oxreserved = 0 where oxid = " . oxDb::getDb()->quote( $sVoucherID );
            oxDb::getDb()->Execute($sQ);
        }
    }

    public function getDiscountValue( $dPrice )
    {
        $oSerie = $this->getSerie();
        if ( $oSerie->oxvoucherseries__oxdiscounttype->value == 'absolute' ) {
            $oCur = $this->getConfig()->getActShopCurrencyObject();
            $dDiscount = $oSerie->oxvoucherseries__oxdiscount->value * $oCur->rate;
        } else {
            $dDiscount = $oSerie->oxvoucherseries__oxdiscount->value / 100 * $dPrice;
        }

        if ( $dDiscount > $dPrice ) {
            $oEx = oxNew( 'oxVoucherException' );
            $oEx->setMessage('EXCEPTION_VOUCHER_TOTALBELOWZERO');
            $oEx->setVoucherNr($this->oxVouchers__voucherNr->value);
            throw $oEx;
        }

        return $dDiscount;
    }

    // Checking General Availability
    public function checkVoucherAvailability( $aVouchers, $dPrice )
    {
        $this->_isAvailableWithSameSeries( $aVouchers );
        $this->_isAvailableWithOtherSeries( $aVouchers );
        $this->_isValidDate();
        $this->_isAvailablePrice( $dPrice );
        $this->_isNotReserved();

        // returning true - no exception was thrown
        return true;
    }

    public function checkBasketVoucherAvailability( $aVouchers, $dPrice )
    {
        $this->_isAvailableWithSameSeries( $aVouchers );
        $this->_isAvailableWithOtherSeries( $aVouchers );
        $this->_isValidDate();
        $this->_isAvailablePrice( $dPrice );

        // returning true - no exception was thrown
        return true;
    }

    protected function _isAvailablePrice( $dPrice )
    {
        if ( $this->getDiscountValue( $dPrice ) < 0 ) {
            $oEx = oxNew( 'oxVoucherException' );
            $oEx->setMessage('EXCEPTION_VOUCHER_TOTALBELOWZERO');
            $oEx->setVoucherNr($this->oxVouchers__voucherNr->value);
            throw $oEx;
        }
        $oSerie = $this->getSerie();
        $oCur = $this->getConfig()->getActShopCurrencyObject();
        if ( $oSerie->oxvoucherseries__oxminimumvalue->value && $dPrice < ($oSerie->oxvoucherseries__oxminimumvalue->value*$oCur->rate) ) {
            $oEx = oxNew( 'oxVoucherException' );
            $oEx->setMessage('EXCEPTION_VOUCHER_INCORRECTPRICE');
            $oEx->setVoucherNr($this->oxVouchers__voucherNr->value);
            throw $oEx;
        }

        return true;
    }

    protected function _isAvailableWithSameSeries( $aVouchers )
    {
        if ( is_array( $aVouchers ) ) {
            $sId = $this->getId();
            if (isset($aVouchers[$sId])) {
                unset($aVouchers[$sId]);
            }
            $oSerie = $this->getSerie();
            if (!$oSerie->oxvoucherseries__oxallowsameseries->value) {
                foreach ( $aVouchers as $voucherId => $voucherNr ) {
                    $oVoucher = oxNew( 'oxvoucher' );
                    $oVoucher->load($voucherId);
                    if ( $this->oxvouchers__oxvoucherserieid->value == $oVoucher->oxvouchers__oxvoucherserieid->value ) {
                            $oEx = oxNew( 'oxVoucherException' );
                            $oEx->setMessage('EXCEPTION_VOUCHER_NOTALLOWEDSAMESERIES');
                            throw $oEx;
                    }
                }
            }
        }

        return true;
    }

    protected function _isAvailableWithOtherSeries( $aVouchers )
    {
        if ( is_array( $aVouchers ) && count($aVouchers) ) {
            $oSerie = $this->getSerie();
            $sIds = '\''.implode('\',\'', array_keys($aVouchers)).'\'';
            $blAvailable = true;
            if (!$oSerie->oxvoucherseries__oxallowotherseries->value) {
                // just search for vouchers with different series
                $sSql  = "select 1 from oxvouchers where oxvouchers.oxid in ($sIds) and ";
                $sSql .= "oxvouchers.oxvoucherserieid != " . oxDb::getDb()->quote( $this->oxvouchers__oxvoucherserieid->value ) ;
                $blAvailable &= !oxDb::getDb()->getOne($sSql);
            } else {
                // search for vouchers with different series and those vouchers do not allow other series
                $sSql  = "select 1 from oxvouchers left join oxvoucherseries on oxvouchers.oxvoucherserieid=oxvoucherseries.oxid ";
                $sSql .= "where oxvouchers.oxid in ($sIds) and oxvouchers.oxvoucherserieid != " . oxDb::getDb()->quote( $this->oxvouchers__oxvoucherserieid->value );
                $sSql .= "and not oxvoucherseries.oxallowotherseries";
                $blAvailable &= !oxDb::getDb()->getOne($sSql);
            }
            if ( !$blAvailable ) {
                    $oEx = oxNew( 'oxVoucherException' );
                    $oEx->setMessage('EXCEPTION_VOUCHER_NOTALLOWEDOTHERSERIES');
                    $oEx->setVoucherNr($this->oxVouchers__voucherNr->value);
                    throw $oEx;
            }
        }

        return true;
    }

    protected function _isValidDate()
    {
        $oSerie = $this->getSerie();
        // if time is not set - keep it as active by default
        $sDefTimeStamp = oxUtilsDate::getInstance()->formatDBDate( '-' );
        if ( $oSerie->oxvoucherseries__oxbegindate->value == $sDefTimeStamp &&
             $oSerie->oxvoucherseries__oxenddate->value == $sDefTimeStamp ) {
            return true;
        }

        if ( ( strtotime( $oSerie->oxvoucherseries__oxbegindate->value ) < time() &&
              strtotime( $oSerie->oxvoucherseries__oxenddate->value ) > time() ) ||
            !$oSerie->oxvoucherseries__oxenddate->value ||
            $oSerie->oxvoucherseries__oxenddate->value == $sDefTimeStamp ) {
            return true;
        }

        $oEx = oxNew( 'oxVoucherException' );
        $oEx->setMessage('EXCEPTION_VOUCHER_ISNOTVALIDDATE');
        throw $oEx;
    }

    protected function _isNotReserved()
    {

        if ( $this->oxvouchers__oxreserved->value < time() - 3600 * 3 ) {
            return true;
        }

        $oEx = oxNew( 'oxVoucherException' );
        $oEx->setMessage('EXCEPTION_VOUCHER_ISRESERVED');
        throw $oEx;
    }

    // Checking User Availability
    public function checkUserAvailability( $oUser )
    {

        $this->_isAvailableInOtherOrder( $oUser );
        $this->_isValidUserGroup( $oUser );

        // returning true if no exception was thrown
        return true;
    }

    protected function _isAvailableInOtherOrder( $oUser )
    {
        $oSerie = $this->getSerie();
        if ( !$oSerie->oxvoucherseries__oxallowuseanother->value ) {

            $sSelect  = 'select count(*) from '.$this->getViewName().' where oxuserid = '. oxDb::getDb()->quote( $oUser->oxuser__oxid->value ) . ' and ';
            $sSelect .= 'oxvoucherserieid = ' . oxDb::getDb()->quote( $this->oxvouchers__oxvoucherserieid->value ) . ' and ';
            $sSelect .= 'oxorderid is not NULL and oxorderid != "" ';

            if ( oxDb::getDb()->getOne( $sSelect )) {
                $oEx = oxNew( 'oxVoucherException' );
                $oEx->setMessage('EXCEPTION_VOUCHER_NOTAVAILABLEINOTHERORDER');
                $oEx->setVoucherNr($this->oxVouchers__voucherNr->value);
                throw $oEx;
            }
        }

        return true;
    }

    protected function _isValidUserGroup( $oUser )
    {
        $oVoucherSerie = $this->getSerie();
        $oUserGroups = $oVoucherSerie->setUserGroups();

        // dodger Task #1555 R Voucher does not work for not logged user?
        if ( !$oUserGroups->count() ) {
            return true;
        }

        if ( $oUser ) {
            foreach ( $oUserGroups as $oGroup ) {
                if ( $oUser->inGroup( $oGroup->getId() ) ) {
                    return true;
                }
            }
        }

        $oEx = oxNew( 'oxVoucherException' );
        $oEx->setMessage( 'EXCEPTION_VOUCHER_NOTVALIDUSERGROUP' );
        $oEx->setVoucherNr( $this->oxvouchers__vouchernr->value );
        throw $oEx;
    }

    public function getSimpleVoucher()
    {
        $oVoucher = new oxStdClass();
        $oVoucher->sVoucherId = $this->getId();
        $oVoucher->sVoucherNr = $this->oxvouchers__oxvouchernr->value;
        // R. setted in oxbasket : $oVoucher->fVoucherdiscount = oxLang::getInstance()->formatCurrency( $this->oxvouchers__oxdiscount->value );

        return $oVoucher;
    }

    public function getSerie()
    {
        if ($this->_oSerie !== null) {
            return $this->_oSerie;
        }
        $oSerie = oxNew('oxvoucherserie');
        if (!$oSerie->load($this->oxvouchers__oxvoucherserieid->value)) {
            throw new oxObjectException();
        }
        $this->_oSerie = $oSerie;
        return $oSerie;
    }

    public function __get( $sName )
    {
        switch ( $sName ) {

            // simple voucher mapping
            case 'sVoucherId':
                return $this->getId();
                break;
            case 'sVoucherNr':
                return $this->oxvouchers__oxvouchernr;
                break;
            case 'fVoucherdiscount':
                return $this->oxvouchers__oxdiscount;
                break;

            // deprecated values for email templates
            case 'oxmodvouchers__oxvouchernr':
                return $this->oxvouchers__oxvouchernr;
                break;
            case 'oxmodvouchers__oxdiscounttype':
                return $this->getSerie()->oxvoucherseries__oxdiscounttype;
                break;
            case 'oxmodvouchers__oxdiscount':
                // former email templates are expecting type dependent discount values !!!
                if($this->getSerie()->oxvoucherseries__oxdiscounttype->value == 'absolute') {
                    return $this->oxvouchers__oxdiscount;
                } else {
                    return $this->getSerie()->oxvoucherseries__oxdiscount;
                }
                break;
        }
        return parent::__get($sName);
    }
}

---