oxcmp_basket.php

Go to the documentation of this file.

<?php

class oxcmp_basket extends oxView
{

    protected $_blIsComponent = true;

    protected $_sLastCallFnc = null;

    public $aRedirectParams = array('cnid', // category id
                                    'mnid', // manufacturer id
                                    'anid', // active article id
                                    'tpl', // spec. template
                                    'listtype', // list type
                                    'searchcnid', // search category
                                    'searchvendor', // search vendor
                                    'searchmanufacturer', // search manufacturer
                                    // @deprecated v5.3 (2016-05-04); Tags will be moved to own module.
                                    'searchtag', // search tag
                                    // END deprecated
                                    // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
                                    'searchrecomm', // search recomendation
                                    'recommid' // recomm. list id
                                    // END deprecated
    );

    public function init()
    {
        $oConfig = $this->getConfig();
        if ($oConfig->getConfigParam('blPsBasketReservationEnabled')) {
            if ($oReservations = $this->getSession()->getBasketReservations()) {
                if (!$oReservations->getTimeLeft()) {
                    $oBasket = $this->getSession()->getBasket();
                    if ($oBasket && $oBasket->getProductsCount()) {
                        $oBasket->deleteBasket();
                    }
                }
                $iLimit = (int) $oConfig->getConfigParam('iBasketReservationCleanPerRequest');
                if (!$iLimit) {
                    $iLimit = 200;
                }
                $oReservations->discardUnusedReservations($iLimit);
            }
        }

        parent::init();

        // Basket exclude
        if ($this->getConfig()->getConfigParam('blBasketExcludeEnabled')) {
            if ($oBasket = $this->getSession()->getBasket()) {
                $this->getParent()->setRootCatChanged($this->isRootCatChanged() && $oBasket->getContents());
            }
        }
    }

    public function render()
    {
        // recalculating
        if ($oBasket = $this->getSession()->getBasket()) {
            $oBasket->calculateBasket(false);
        }

        parent::render();

        return $oBasket;
    }

    public function tobasket($sProductId = null, $dAmount = null, $aSel = null, $aPersParam = null, $blOverride = false)
    {
        // adding to basket is not allowed ?
        $myConfig = $this->getConfig();
        if (oxRegistry::getUtils()->isSearchEngine()) {
            return;
        }

        // adding articles
        if ($aProducts = $this->_getItems($sProductId, $dAmount, $aSel, $aPersParam, $blOverride)) {

            $this->_setLastCallFnc('tobasket');

            $database = oxDb::getDb();
            $database->startTransaction();
            try {
                $oBasketItem = $this->_addItems($aProducts);
                //reserve active basket
                if (oxRegistry::getConfig()->getConfigParam('blPsBasketReservationEnabled')) {
                    $basket = oxRegistry::getSession()->getBasket();
                    oxRegistry::getSession()->getBasketReservations()->reserveBasket($basket);
                }
            } catch (\Exception $exception) {
                $database->rollbackTransaction();
                unset($oBasketItem);
                throw $exception;
            }
            $database->commitTransaction();

            // new basket item marker
            if ($oBasketItem && $myConfig->getConfigParam('iNewBasketItemMessage') != 0) {
                $oNewItem = new stdClass();
                $oNewItem->sTitle = $oBasketItem->getTitle();
                $oNewItem->sId = $oBasketItem->getProductId();
                $oNewItem->dAmount = $oBasketItem->getAmount();
                $oNewItem->dBundledAmount = $oBasketItem->getdBundledAmount();

                // passing article
                oxRegistry::getSession()->setVariable('_newitem', $oNewItem);
            }


            // redirect to basket
            return $this->_getRedirectUrl();
        }
    }

    public function changebasket(
        $sProductId = null,
        $dAmount = null,
        $aSel = null,
        $aPersParam = null,
        $blOverride = true
    ) {
        if (!oxRegistry::getSession()->checkSessionChallenge()) {
            return;
        }

        // adding to basket is not allowed ?
        if (oxRegistry::getUtils()->isSearchEngine()) {
            return;
        }

        // fetching item ID
        if (!$sProductId) {
            $sBasketItemId = oxRegistry::getConfig()->getRequestParameter('bindex');

            if ($sBasketItemId) {
                $oBasket = $this->getSession()->getBasket();
                //take params
                $aBasketContents = $oBasket->getContents();
                $oItem = $aBasketContents[$sBasketItemId];

                $sProductId = isset($oItem) ? $oItem->getProductId() : null;
            } else {
                $sProductId = oxRegistry::getConfig()->getRequestParameter('aid');
            }
        }

        // fetching other needed info
        $dAmount = isset($dAmount) ? $dAmount : oxRegistry::getConfig()->getRequestParameter('am');
        $aSel = isset($aSel) ? $aSel : oxRegistry::getConfig()->getRequestParameter('sel');
        $aPersParam = $aPersParam ? $aPersParam : oxRegistry::getConfig()->getRequestParameter('persparam');

        // adding articles
        if ($aProducts = $this->_getItems($sProductId, $dAmount, $aSel, $aPersParam, $blOverride)) {

            // information that last call was changebasket
            $oBasket = $this->getSession()->getBasket();
            $oBasket->onUpdate();

            $this->_setLastCallFnc('changebasket');

            $database = oxDb::getDb();
            $database->startTransaction();
            try {
                $oBasketItem = $this->_addItems($aProducts);
                // reserve active basket
                if (oxRegistry::getConfig()->getConfigParam('blPsBasketReservationEnabled')) {
                    oxRegistry::getSession()->getBasketReservations()->reserveBasket($oBasket);
                }
            } catch (\Exception $exception) {
                $database->rollbackTransaction();
                unset($oBasketItem);
                throw $exception;
            }
            $database->commitTransaction();
        }

    }

    protected function _getRedirectUrl()
    {

        // active class
        $sClass = oxRegistry::getConfig()->getRequestParameter('cl');
        $sClass = $sClass ? $sClass . '?' : 'start?';
        $sPosition = '';

        // setting redirect parameters
        foreach ($this->aRedirectParams as $sParamName) {
            $sParamVal = oxRegistry::getConfig()->getRequestParameter($sParamName);
            $sPosition .= $sParamVal ? $sParamName . '=' . $sParamVal . '&' : '';
        }

        // special treatment
        // search param
        $sParam = rawurlencode(oxRegistry::getConfig()->getRequestParameter('searchparam', true));
        $sPosition .= $sParam ? 'searchparam=' . $sParam . '&' : '';

        // current page number
        $iPageNr = (int) oxRegistry::getConfig()->getRequestParameter('pgNr');
        $sPosition .= ($iPageNr > 0) ? 'pgNr=' . $iPageNr . '&' : '';

        // reload and backbutton blocker
        if ($this->getConfig()->getConfigParam('iNewBasketItemMessage') == 3) {

            // saving return to shop link to session
            oxRegistry::getSession()->setVariable('_backtoshop', $sClass . $sPosition);

            // redirecting to basket
            $sClass = 'basket?';
        }

        return $sClass . $sPosition;
    }

    protected function _getItems(
        $sProductId = null,
        $dAmount = null,
        $aSel = null,
        $aPersParam = null,
        $blOverride = false
    ) {
        // collecting items to add
        $aProducts = oxRegistry::getConfig()->getRequestParameter('aproducts');

        // collecting specified item
        $sProductId = $sProductId ? $sProductId : oxRegistry::getConfig()->getRequestParameter('aid');
        if ($sProductId) {

            // additionally fetching current product info
            $dAmount = isset($dAmount) ? $dAmount : oxRegistry::getConfig()->getRequestParameter('am');

            // select lists
            $aSel = isset($aSel) ? $aSel : oxRegistry::getConfig()->getRequestParameter('sel');

            // persistent parameters
            if (empty($aPersParam)) {
                $aPersParam = oxRegistry::getConfig()->getRequestParameter('persparam');
                if (!is_array($aPersParam) || empty($aPersParam['details'])) {
                    $aPersParam = null;
                }
            }

            $sBasketItemId = oxRegistry::getConfig()->getRequestParameter('bindex');

            $aProducts[$sProductId] = array('am'           => $dAmount,
                                            'sel'          => $aSel,
                                            'persparam'    => $aPersParam,
                                            'override'     => $blOverride,
                                            'basketitemid' => $sBasketItemId
            );
        }

        if (is_array($aProducts) && count($aProducts)) {

            if (oxRegistry::getConfig()->getRequestParameter('removeBtn') !== null) {
                //setting amount to 0 if removing article from basket
                foreach ($aProducts as $sProductId => $aProduct) {
                    if (isset($aProduct['remove']) && $aProduct['remove']) {
                        $aProducts[$sProductId]['am'] = 0;
                    } else {
                        unset ($aProducts[$sProductId]);
                    }
                }
            }

            return $aProducts;
        }

        return false;
    }

    protected function _addItems($aProducts)
    {
        $oActView = $this->getConfig()->getActiveView();
        $sErrorDest = $oActView->getErrorDestination();

        $oBasket = $this->getSession()->getBasket();
        $oBasketInfo = $oBasket->getBasketSummary();

        $basketItemAmounts = array();

        foreach ($aProducts as $sAddProductId => $aProductInfo) {

            $sProductId = isset($aProductInfo['aid']) ? $aProductInfo['aid'] : $sAddProductId;

            // collecting input
            $oProduct = $oBasketInfo->aArticles[$sProductId];
            $aProducts[$sAddProductId]['oldam'] = isset($oProduct) ? $oProduct : 0;

            $dAmount = isset($aProductInfo['am']) ? $aProductInfo['am'] : 0;
            $aSelList = isset($aProductInfo['sel']) ? $aProductInfo['sel'] : null;
            $aParams = $aProductInfo['persparam'];
            $aPersParam = (isset($aParams) && is_array($aParams) && strlen($aParams['details'])) ? $aParams : null;
            $blOverride = isset($aProductInfo['override']) ? $aProductInfo['override'] : null;
            $blIsBundle = isset($aProductInfo['bundle']) ? true : false;
            $sOldBasketItemId = isset($aProductInfo['basketitemid']) ? $aProductInfo['basketitemid'] : null;

            try {

                //If we already changed articles so they now exactly match existing ones,
                //we need to make sure we get the amounts correct
                if (isset($basketItemAmounts[$sOldBasketItemId])) {
                    $dAmount = $dAmount + $basketItemAmounts[$sOldBasketItemId];
                }

                $oBasketItem = $oBasket->addToBasket(
                    $sProductId,
                    $dAmount,
                    $aSelList,
                    $aPersParam,
                    $blOverride,
                    $blIsBundle,
                    $sOldBasketItemId
                );

                if (is_a($oBasketItem, 'oxBasketItem')) {
                    $basketItemId = $oBasketItem->getBasketItemKey();
                }
                if (!empty($basketItemId)) {
                    $basketItemAmounts[$basketItemId] += $dAmount;
                }

            } catch (oxOutOfStockException $oEx) {
                $oEx->setDestination($sErrorDest);
                // #950 Change error destination to basket popup
                if (!$sErrorDest && $this->getConfig()->getConfigParam('iNewBasketItemMessage') == 2) {
                    $sErrorDest = 'popup';
                }
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx, false, (bool) $sErrorDest, $sErrorDest);
            } catch (oxArticleInputException $oEx) {
                //add to display at specific position
                $oEx->setDestination($sErrorDest);
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx, false, (bool) $sErrorDest, $sErrorDest);
            } catch (oxNoArticleException $oEx) {
                //ignored, best solution F ?
            }
            if (!$oBasketItem) {
                $oInfo = $oBasket->getBasketSummary();
                $oProduct = $oInfo->aArticles[$sProductId];
                $aProducts[$sAddProductId]['am'] = isset($oProduct) ? $oProduct : 0;
            }
        }

        //if basket empty remove posible gift card
        if ($oBasket->getProductsCount() == 0) {
            $oBasket->setCardId(null);
        }

        // information that last call was tobasket
        $this->_setLastCall($this->_getLastCallFnc(), $aProducts, $oBasketInfo);

        return $oBasketItem;
    }

    protected function _setLastCall($sCallName, $aProductInfo, $aBasketInfo)
    {
        oxRegistry::getSession()->setVariable('aLastcall', array($sCallName => $aProductInfo));
    }

    protected function _setLastCallFnc($sCallName)
    {
        $this->_sLastCallFnc = $sCallName;
    }

    protected function _getLastCallFnc()
    {
        return $this->_sLastCallFnc;
    }

    public function isRootCatChanged()
    {
        // in Basket
        $oBasket = $this->getSession()->getBasket();
        if ($oBasket->showCatChangeWarning()) {
            $oBasket->setCatChangeWarningState(false);

            return true;
        }

        // in Category, only then category is empty ant not equal to default category
        $sDefCat = oxRegistry::getConfig()->getActiveShop()->oxshops__oxdefcat->value;
        $sActCat = oxRegistry::getConfig()->getRequestParameter('cnid');
        $oActCat = oxnew('oxcategory');
        if ($sActCat && $sActCat != $sDefCat && $oActCat->load($sActCat)) {
            $sActRoot = $oActCat->oxcategories__oxrootid->value;
            if ($oBasket->getBasketRootCatId() && $sActRoot != $oBasket->getBasketRootCatId()) {
                return true;
            }
        }

        return false;
    }

    public function executeuserchoice()
    {

        // redirect to basket
        if (oxRegistry::getConfig()->getRequestParameter("tobasket")) {
            return "basket";
        } else {
            // clear basket
            $this->getSession()->getBasket()->deleteBasket();
            $this->getParent()->setRootCatChanged(false);
        }
    }

}