order.php

Go to the documentation of this file.

<?php

class order extends oxUBase
{
    protected $_oPayment = null;

    protected $_oBasket = null;

    protected $_sOrderRemark = null;

    protected $_oBasketArtList = null;

    protected $_sRemoteAddress = null;

    protected $_oDelAddress = null;

    protected $_oShipSet = null;

    protected $_blConfirmAGB = null;

    protected $_blShowOrderButtonOnTop = null;

    protected $_blConfirmAGBError = null;

    protected $_blConfirmCustInfo = null;

    protected $_blConfirmCustInfoError = null;

    protected $_sThisTemplate = 'order.tpl';

    protected $_blIsOrderStep = true;

    protected $_iWrapCnt = null;

    public function init()
    {
        // disabling performance control variable
        $this->getConfig()->setConfigParam( 'bl_perfCalcVatOnlyForBasketOrder', false );

        // recalc basket cause of payment stuff
        if ( $oBasket = $this->getBasket() ) {
            $oBasket->onUpdate();
        }

        parent::init();
    }

    public function render()
    {
        $myConfig = $this->getConfig();

        // can we proceed with ordering ?
        $oBasket = $this->getBasket();
        $oUser = $this->getUser();

        if ( !$oBasket || !$oUser || ( $oBasket && !$oBasket->getProductsCount() ) ) {
            oxUtils::getInstance()->redirect( $myConfig->getShopHomeURL() );
        }

        // payment is set ?
        if ( !$this->getPayment() ) {
            // redirecting to payment step on error ..
            oxUtils::getInstance()->redirect( $myConfig->getShopCurrentURL().'&cl=payment' );
        }

        parent::render();

        $this->_aViewData['payment']     = $this->getPayment();
        $this->_aViewData['execute_fnc'] = $this->getExecuteFnc();

        // user order remark
        $this->_aViewData['order_remark'] = $this->getOrderRemark();

        // passing basket articles
        $this->_aViewData['basketitemlist'] = $this->getBasketArticles();

        // reload blocker
        if ( !oxSession::getVar( 'sess_challenge' ) ) {
            oxSession::setVar( 'sess_challenge', oxUtilsObject::getInstance()->generateUID() );
        }

        // passing delivery address information
        $this->_aViewData['oDelAdress'] = $this->getDelAddress();

        // multiple shipping options
        $this->_aViewData['oShipSet'] = $this->getShipSet();

        //config options ( what order confirmation checkboxes must be displayed )
        $this->_aViewData['blConfirmAGB']      = $this->isConfirmAGBActive();
        $this->_aViewData['blConfirmCustInfo'] = $this->isConfirmCustInfoActive();

        $this->_aViewData['agb_err']      = $this->isConfirmAGBError();
        $this->_aViewData['custinfo_err'] = $this->isConfirmCustInfoError();

        // for old templates
        $this->_aViewData['iswishlist'] = (bool) $this->_aViewData['iswishlist'] & $this->isWrapping();

        return $this->_sThisTemplate;
    }

    public function execute()
    {
        if (!$this->getSession()->checkSessionChallenge()) {
            return;
        }

        $myConfig = $this->getConfig();

        if ( !oxConfig::getParameter( 'ord_agb' ) && $myConfig->getConfigParam( 'blConfirmAGB' ) ) {
            $this->_blConfirmAGBError = 1;
            return;
        }

        // for compatibility reasons for a while. will be removed in future
        if ( oxConfig::getParameter( 'ord_custinfo' ) !== null && !oxConfig::getParameter( 'ord_custinfo' ) && $this->isConfirmCustInfoActive() ) {
            $this->_blConfirmCustInfoError =  1;
            return;
        }

        // additional check if we really really have a user now
        if ( !$oUser= $this->getUser() ) {
            return 'user';
        }

        // get basket contents
        $oBasket  = $this->getSession()->getBasket();
        if ( $oBasket->getProductsCount() ) {

            try {
                $oOrder = oxNew( 'oxorder' );

                // finalizing ordering process (validating, storing order into DB, executing payment, setting status ...)
                $iSuccess = $oOrder->finalizeOrder( $oBasket, $oUser );

                // performing special actions after user finishes order (assignment to special user groups)
                $oUser->onOrderExecute( $oBasket, $iSuccess );

                // proceeding to next view
                return $this->_getNextStep( $iSuccess );
            } catch ( oxOutOfStockException $oEx ) {
                oxUtilsView::getInstance()->addErrorToDisplay( $oEx, false, true, 'basket' );
            } catch ( oxNoArticleException $oEx ) {
                oxUtilsView::getInstance()->addErrorToDisplay( $oEx );
            } catch ( oxArticleInputException $oEx ) {
                oxUtilsView::getInstance()->addErrorToDisplay( $oEx );
            }
        }
    }

    protected function _getNextStep( $iSuccess )
    {
        $sNextStep = 'thankyou';

        //little trick with switch for multiple cases
        switch ( true ) {
            case ( $iSuccess === oxOrder::ORDER_STATE_MAILINGERROR ):
                $sNextStep = 'thankyou?mailerror=1';
                break;
            case ( $iSuccess === oxOrder::ORDER_STATE_PAYMENTERROR ):
                // no authentication, kick back to payment methods
                oxSession::setVar( 'payerror', 2 );
                $sNextStep = 'payment?payerror=2';
                break;
            case ( $iSuccess === oxOrder::ORDER_STATE_ORDEREXISTS ):
                break;  // reload blocker activ
            case ( is_numeric( $iSuccess ) && $iSuccess > 3 ):
                oxSession::setVar( 'payerror', $iSuccess );
                $sNextStep = 'payment?payerror='.$iSuccess;
                break;
            case ( !is_numeric( $iSuccess ) && $iSuccess ):
                //instead of error code getting error text and setting payerror to -1
                oxSession::setVar( 'payerror', -1 );
                $iSuccess = urlencode( $iSuccess );
                $sNextStep = 'payment?payerror=-1&payerrortext='.$iSuccess;
                break;
            default:
                break;
        }

        return $sNextStep;
    }

    public function getPayment()
    {
        if ( $this->_oPayment === null ) {
            $this->_oPayment = false;

            $oBasket = $this->getBasket();
            $oUser = $this->getUser();

            // payment is set ?
            $sPaymentid = $oBasket->getPaymentId();
            $aDynvalue  = oxConfig::getParameter( 'dynvalue' );
            $oPayment   = oxNew( 'oxpayment' );

            //getting basket price form payment
            $dBasketPrice = $oBasket->getPriceForPayment();

            if ( $sPaymentid && $oPayment->load( $sPaymentid ) &&
                $oPayment->isValidPayment( $aDynvalue, $this->getConfig()->getShopId(), $oUser, $dBasketPrice, oxConfig::getParameter( 'sShipSet' ) ) ) {
                $this->_oPayment = $oPayment;
            }
        }
        return $this->_oPayment;
    }

    public function getBasket()
    {
        if ( $this->_oBasket === null ) {
            $this->_oBasket = false;
            if ( $oBasket = $this->getSession()->getBasket() ) {
                $this->_oBasket = $oBasket;
            }
        }
        return $this->_oBasket;
    }

    public function getExecuteFnc()
    {
        return 'execute';
    }

    public function getOrderRemark()
    {
        if ( $this->_sOrderRemark === null ) {
            $this->_sOrderRemark = false;
            if ( $sRemark = oxSession::getVar( 'ordrem' ) ) {
                $this->_sOrderRemark = oxConfig::checkSpecialChars( $sRemark );
            }
        }
        return $this->_sOrderRemark;
    }

    public function getBasketArticles()
    {
        if ( $this->_oBasketArtList === null ) {
            $this->_oBasketArtList = false;
            if ( $oBasket = $this->getBasket() ) {
                $this->_oBasketArtList = $oBasket->getBasketArticles();
            }
        }
        return $this->_oBasketArtList;
    }

    public function getDelAddress()
    {
        if ( $this->_oDelAddress === null ) {
            $this->_oDelAddress = false;
            $oOrder = oxNew( 'oxorder' );
            $this->_oDelAddress = $oOrder->getDelAddressInfo();
        }
        return $this->_oDelAddress;
    }

    public function getShipSet()
    {
        if ( $this->_oShipSet === null ) {
            $this->_oShipSet = false;
            if ( $oBasket = $this->getBasket() ) {
                $oShipSet = oxNew( 'oxdeliveryset' );
                if ( $oShipSet->load( $oBasket->getShippingId() )) {
                    $this->_oShipSet = $oShipSet;
                }
            }
        }
        return $this->_oShipSet;
    }

    public function isConfirmAGBActive()
    {
        if ( $this->_blConfirmAGB === null ) {
            $this->_blConfirmAGB = false;
            $this->_blConfirmAGB = $this->getConfig()->getConfigParam( 'blConfirmAGB' );
        }
        return $this->_blConfirmAGB;
    }

    public function isConfirmCustInfoActive()
    {
        if ( $this->_blConfirmCustInfo === null ) {
            $this->_blConfirmCustInfo = false;
            $sConf = $this->getConfig()->getConfigParam( 'blConfirmCustInfo' );
            if ( $sConf != null ) {
                $this->_blConfirmCustInfo = $this->getConfig()->getConfigParam( 'blConfirmCustInfo' );
            }
        }
        return $this->_blConfirmCustInfo;
    }

    public function isConfirmAGBError()
    {
        return $this->_blConfirmAGBError;
    }

    public function isConfirmCustInfoError()
    {
        return $this->_blConfirmCustInfoError;
    }

    public function showOrderButtonOnTop()
    {
        if ( $this->_blShowOrderButtonOnTop === null ) {
            $this->_blShowOrderButtonOnTop = false;
            $this->_blShowOrderButtonOnTop = $this->getConfig()->getConfigParam( 'blShowOrderButtonOnTop' );
        }
        return $this->_blShowOrderButtonOnTop;
    }

    public function isWrapping()
    {
        if (!$this->getViewConfig()->getShowGiftWrapping() ) {
            return false;
        }

        if ( $this->_iWrapCnt === null ) {
            $this->_iWrapCnt = 0;

            $oWrap = oxNew( 'oxwrapping' );
            $this->_iWrapCnt += $oWrap->getWrappingCount( 'WRAP' );
            $this->_iWrapCnt += $oWrap->getWrappingCount( 'CARD' );
        }

        return (bool) $this->_iWrapCnt;
    }
}