review.php

Go to the documentation of this file.

<?php

class Review extends Details
{

    protected $_oRevUser = null;

    protected $_oActObject = null;

    protected $_oActiveRecommList = null;

    protected $_oActiveRecommItems = null;

    protected $_blRate = null;

    protected $_aReviews = null;

    protected $_oCrossSelling = null;

    protected $_oSimilarProducts = null;

    protected $_oRecommList = null;

    protected $_blReviewSendStatus = null;

    protected $_oPageNavigation = null;

    protected $_sThisTemplate = 'page/review/review.tpl';

    protected $_sThisLoginTemplate = 'page/review/review_login.tpl';

    protected $_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW;

    public function getViewId()
    {
        return oxUBase::getViewId();
    }

    public function init()
    {
        // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
        if (oxRegistry::getConfig()->getRequestParameter('recommid') && !$this->getActiveRecommList()) {
            oxRegistry::getUtils()->redirect($this->getConfig()->getShopHomeURL(), true, 302);
        }
        // END deprecated

        oxUBase::init();
    }

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

        if (!$oConfig->getConfigParam("bl_perfLoadReviews")) {
            oxRegistry::getUtils()->redirect($oConfig->getShopHomeURL());
        }

        oxUBase::render();
        if (!($this->getReviewUser())) {
            $this->_sThisTemplate = $this->_sThisLoginTemplate;
        } else {

            // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
            $oActiveRecommList = $this->getActiveRecommList();
            $oList = $this->getActiveRecommItems();

            if ($oActiveRecommList) {
                if ($oList && $oList->count()) {
                    $this->_iAllArtCnt = $oActiveRecommList->getArtCount();
                }
                // load only lists which we show on screen
                $iNrofCatArticles = $this->getConfig()->getConfigParam('iNrofCatArticles');
                $iNrofCatArticles = $iNrofCatArticles ? $iNrofCatArticles : 10;
                $this->_iCntPages = round($this->_iAllArtCnt / $iNrofCatArticles + 0.49);
            }
            // END deprecated
        }

        return $this->_sThisTemplate;
    }

    public function saveReview()
    {
        if (!oxRegistry::getSession()->checkSessionChallenge()) {
            return;
        }

        if (($oRevUser = $this->getReviewUser()) && $this->canAcceptFormData()) {

            if (($oActObject = $this->_getActiveObject()) && ($sType = $this->_getActiveType())) {

                if (($dRating = oxRegistry::getConfig()->getRequestParameter('rating')) === null) {
                    $dRating = oxRegistry::getConfig()->getRequestParameter('artrating');
                }

                if ($dRating !== null) {
                    $dRating = (int) $dRating;
                }

                //save rating
                if ($dRating !== null && $dRating >= 1 && $dRating <= 5) {
                    $oRating = oxNew('oxrating');
                    if ($oRating->allowRating($oRevUser->getId(), $sType, $oActObject->getId())) {
                        $oRating->oxratings__oxuserid = new oxField($oRevUser->getId());
                        $oRating->oxratings__oxtype = new oxField($sType);
                        $oRating->oxratings__oxobjectid = new oxField($oActObject->getId());
                        $oRating->oxratings__oxrating = new oxField($dRating);
                        $oRating->save();

                        $oActObject->addToRatingAverage($dRating);

                        $this->_blReviewSendStatus = true;
                    }
                }

                if (($sReviewText = trim(( string ) oxRegistry::getConfig()->getRequestParameter('rvw_txt', true)))) {
                    $oReview = oxNew('oxreview');
                    $oReview->oxreviews__oxobjectid = new oxField($oActObject->getId());
                    $oReview->oxreviews__oxtype = new oxField($sType);
                    $oReview->oxreviews__oxtext = new oxField($sReviewText, oxField::T_RAW);
                    $oReview->oxreviews__oxlang = new oxField(oxRegistry::getLang()->getBaseLanguage());
                    $oReview->oxreviews__oxuserid = new oxField($oRevUser->getId());
                    $oReview->oxreviews__oxrating = new oxField(($dRating !== null) ? $dRating : null);
                    $oReview->save();

                    $this->_blReviewSendStatus = true;
                }
            }
        }
    }

    public function getReviewUser()
    {
        if ($this->_oRevUser === null) {
            $this->_oRevUser = false;
            $oUser = oxNew("oxuser");

            if ($sUserId = $oUser->getReviewUserId($this->getReviewUserHash())) {
                // review user, by link or other source?
                if ($oUser->load($sUserId)) {
                    $this->_oRevUser = $oUser;
                }
            } elseif ($oUser = $this->getUser()) {
                // session user?
                $this->_oRevUser = $oUser;
            }

        }

        return $this->_oRevUser;
    }

    public function getReviewUserHash()
    {
        return oxRegistry::getConfig()->getRequestParameter('reviewuserhash');
    }

    protected function _getActiveObject()
    {
        if ($this->_oActObject === null) {
            $this->_oActObject = false;

            if (($oProduct = $this->getProduct())) {
                $this->_oActObject = $oProduct;
            } elseif (($oRecommList = $this->getActiveRecommList())) {
                $this->_oActObject = $oRecommList;
            }
        }

        return $this->_oActObject;
    }

    protected function _getActiveType()
    {
        $sType = null;
        if ($this->getProduct()) {
            $sType = 'oxarticle';
            // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
        } elseif ($this->getActiveRecommList()) {
            $sType = 'oxrecommlist';
            // END deprecated
        }

        return $sType;
    }

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

        if ($this->_oActiveRecommList === null) {
            $this->_oActiveRecommList = false;

            if ($sRecommId = oxRegistry::getConfig()->getRequestParameter('recommid')) {
                $oActiveRecommList = oxNew('oxrecommlist');
                if ($oActiveRecommList->load($sRecommId)) {
                    $this->_oActiveRecommList = $oActiveRecommList;
                }
            }
        }

        return $this->_oActiveRecommList;
    }

    public function canRate()
    {
        if ($this->_blRate === null) {
            $this->_blRate = false;
            if (($oActObject = $this->_getActiveObject()) && ($oRevUser = $this->getReviewUser())) {
                $oRating = oxNew('oxrating');
                $this->_blRate = $oRating->allowRating(
                    $oRevUser->getId(),
                    $this->_getActiveType(),
                    $oActObject->getId()
                );
            }
        }

        return $this->_blRate;
    }

    public function getReviews()
    {
        if ($this->_aReviews === null) {
            $this->_aReviews = false;
            if ($oObject = $this->_getActiveObject()) {
                $this->_aReviews = $oObject->getReviews();
            }
        }

        return $this->_aReviews;
    }

    public function getRecommList()
    {
        if ($this->_oRecommList === null) {
            $this->_oRecommList = false;
            if ($oProduct = $this->getProduct()) {
                $oRecommList = oxNew('oxrecommlist');
                $this->_oRecommList = $oRecommList->getRecommListsByIds(array($oProduct->getId()));
            }
        }

        return $this->_oRecommList;
    }

    public function getActiveRecommItems()
    {
        if ($this->_oActiveRecommItems === null) {
            $this->_oActiveRecommItems = false;
            if ($oActiveRecommList = $this->getActiveRecommList()) {
                // sets active page
                $iActPage = (int) oxRegistry::getConfig()->getRequestParameter('pgNr');
                $iActPage = ($iActPage < 0) ? 0 : $iActPage;

                // load only lists which we show on screen
                $iNrofCatArticles = $this->getConfig()->getConfigParam('iNrofCatArticles');
                $iNrofCatArticles = $iNrofCatArticles ? $iNrofCatArticles : 10;

                $oList = $oActiveRecommList->getArticles($iNrofCatArticles * $iActPage, $iNrofCatArticles);

                if ($oList && $oList->count()) {
                    foreach ($oList as $oItem) {
                        $oItem->text = $oActiveRecommList->getArtDescription($oItem->getId());
                    }
                    $this->_oActiveRecommItems = $oList;
                }
            }
        }

        return $this->_oActiveRecommItems;
    }

    public function getReviewSendStatus()
    {
        return $this->_blReviewSendStatus;
    }

    public function getPageNavigation()
    {
        if ($this->_oPageNavigation === null) {
            $this->_oPageNavigation = false;
            // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
            if ($this->getActiveRecommList()) {
                $this->_oPageNavigation = $this->generatePageNavigation();
            }
            // END deprecated   
        }

        return $this->_oPageNavigation;
    }

    public function getAdditionalParams()
    {
        $sAddParams = oxUBase::getAdditionalParams();
        // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
        if ($oActRecommList = $this->getActiveRecommList()) {
            $sAddParams .= '&amp;recommid=' . $oActRecommList->getId();
        }
        // END deprecated

        return $sAddParams;
    }

    public function getDynUrlParams()
    {
        $sParams = parent::getDynUrlParams();

        if ($sCnId = oxRegistry::getConfig()->getRequestParameter('cnid')) {
            $sParams .= "&amp;cnid={$sCnId}";
        }
        if ($sAnId = oxRegistry::getConfig()->getRequestParameter('anid')) {
            $sParams .= "&amp;anid={$sAnId}";
        }
        if ($sListType = oxRegistry::getConfig()->getRequestParameter('listtype')) {
            $sParams .= "&amp;listtype={$sListType}";
        }
        // @deprecated since v5.3 (2016-06-17); Listmania will be moved to an own module.
        if ($sRecommId = oxRegistry::getConfig()->getRequestParameter('recommid')) {
            $sParams .= "&amp;recommid={$sRecommId}";
        }
        // END deprecated

        return $sParams;
    }
}