review.php

Go to the documentation of this file.

<?php

class Review extends oxUBase
{
    protected $_sReviewUserId = 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 = 'review.tpl';

    protected $_sThisLoginTemplate = 'review_login.tpl';

    protected $_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW;

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

        parent::init();

        $this->_oActiveRecommList = $this->getActiveRecommList();
        if ( oxConfig::getParameter( 'recommid' ) && !$this->_oActiveRecommList ) {
            oxUtils::getInstance()->redirect( $myConfig->getShopHomeURL() );
        }
    }

    public function render()
    {
        parent::render();

        if ( !$this->_checkDirectReview($this->getReviewUserId()) ) {
            return $this->_sThisTemplate = $this->_sThisLoginTemplate;
        }

        $sReviewUser = oxConfig::getParameter( 'reviewuser' );
        $this->_aViewData['reviewuserid'] = ( !$sReviewUser ) ? oxConfig::getParameter( 'reviewuserid' ) : $sReviewUser;

        $this->_aViewData['reviews'] = $this->getReviews();
        $this->_aViewData['product'] = $this->getProduct();

        // loading product reviews
        $this->_aViewData['crossselllist']     = $this->getCrossSelling();
        $this->_aViewData['similarlist']       = $this->getSimilarProducts();
        $this->_aViewData['similarrecommlist'] = $this->getRecommList();


        $this->_aViewData['actvrecommlist'] = $this->getActiveRecommList();
        $this->_aViewData['itemList']       = $this->getActiveRecommItems();

        if ( $oActiveRecommList = $this->getActiveRecommList() ) {
            $oList = $this->getActiveRecommItems();
            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 );
        }

        $this->_aViewData['pageNavigation'] = $this->getPageNavigation();
        $this->_aViewData['rate'] = $this->canRate();
        $this->_aViewData['success'] = $this->getReviewSendStatus();

        return $this->_sThisTemplate;
    }

    public function saveReview()
    {
        $sReviewUserId = $this->getReviewUserId();

        if ( !$this->_checkDirectReview($sReviewUserId) ) {
            return;
        }

        $sReviewText = trim( ( string ) oxConfig::getParameter( 'rvw_txt' ) );
        $dRating     = ( oxConfig::getParameter( 'rating' ) ) ? oxConfig::getParameter( 'rating' ) : oxConfig::getParameter( 'artrating' );

        if ($dRating < 0 || $dRating > 5) {
            $dRating = null;
        }
        // #1590M
        /*if ( !$sReviewText ) {
            $this->_aViewData['success'] = true;
            return;
        }*/

        $sType     = $this->_getActiveType();
        $sObjectId = $this->_getActiveObject()->getId();
        if ($sType && $sObjectId) {
            //save rating
            if ( $dRating ) {
                $oRating = oxNew( 'oxrating' );
                $oRating->oxratings__oxuserid   = new oxField($sReviewUserId);
                $oRating->oxratings__oxtype     = new oxField($sType, oxField::T_RAW);
                $oRating->oxratings__oxobjectid = new oxField($sObjectId);
                $oRating->oxratings__oxrating   = new oxField($dRating);
                $oRating->save();
                if ( $oProduct = $this->getProduct() ) {
                    $oProduct->addToRatingAverage( $dRating);
                } elseif ($this->_oActiveRecommList) {
                    $this->_oActiveRecommList->addToRatingAverage( $dRating);
                }
                $this->_blReviewSendStatus = true;
            }

            if ( $sReviewText ) {
                $oReview = oxNew( 'oxreview' );
                $oReview->oxreviews__oxuserid   = new oxField($sReviewUserId);
                $oReview->oxreviews__oxtype     = new oxField($sType, oxField::T_RAW);
                $oReview->oxreviews__oxobjectid = new oxField($sObjectId);
                $oReview->oxreviews__oxtext     = new oxField($sReviewText);
                $oReview->oxreviews__oxlang     = new oxField(oxLang::getInstance()->getBaseLanguage());
                $oReview->oxreviews__oxrating   = new oxField(( $dRating) ? $dRating : null);
                $oReview->save();
                $this->_blReviewSendStatus = true;
            }
        }
    }

    protected function _checkDirectReview( $sReviewUserId )
    {
        $oUser = $this->getUser();
        $blAllow = false;
        if ($oUser && ($sReviewUserId == $oUser->getId())) {
            $blAllow = true;
        } else {
            $blAllow = $this->_allowDirectReview( $sReviewUserId );
        }
        return $blAllow;
    }

    protected function _allowDirectReview( $sUserId )
    {
        $oUser = oxNew( 'oxuser' );
        if ( !$oUser->exists( $sUserId ) ) {
            return false;
        }

        return true;
    }

    public function getReviewUserId()
    {
        if ( $this->_sReviewUserId === null ) {
            $this->_sReviewUserId = false;

            //review user from order email
            $sReviewUser = oxConfig::getParameter( 'reviewuser' );
            $sReviewUser = ( !$sReviewUser ) ? oxConfig::getParameter( 'reviewuserid' ) : $sReviewUser;
            if ( $sReviewUser ) {
                $oUser = oxNew( 'oxuser' );
                $sReviewUserId = $oUser->getReviewUserId( $sReviewUser );
            }

            $oUser = $this->getUser();
            if (!$sReviewUserId && $oUser) {
                $sReviewUserId = $oUser->getId();
            }
            $this->_sReviewUserId = $sReviewUserId;
        }
        return $this->_sReviewUserId;
    }

    public function getProduct()
    {
        if ( $this->_oProduct === null ) {
            $this->_oProduct = false;

            if ( $sAnid = oxConfig::getParameter( 'anid' ) ) {
                $this->_oProduct = oxNewArticle( $sAnid );
            }
        }
        return $this->_oProduct;
    }

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

            if ( $oProduct = $this->getProduct() ) {
                $this->_oActObject = $oProduct;
            } elseif ( $this->_oActiveRecommList ) {
                $this->_oActObject = $this->_oActiveRecommList;
            }
        }
        return $this->_oActObject;
    }

    protected function _getActiveType()
    {
        if ( $this->getProduct() ) {
            $sType = 'oxarticle';
        } elseif ($this->_oActiveRecommList) {
            $sType = 'oxrecommlist';
        }
        return $sType;
    }

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

            if ( $sRecommId = oxConfig::getParameter( 'recommid' ) ) {
                $oActiveRecommList = oxNew('oxrecommlist');
                if ( $oActiveRecommList->load( $sRecommId ) ) {
                    $this->_oActiveRecommList = $oActiveRecommList;
                }
            }
        }
        return $this->_oActiveRecommList;
    }

    public function canRate()
    {
        if ( $this->_blRate === null ) {
            $this->_blRate = false;
            $sType     = $this->_getActiveType();
            $sObjectId = $this->_getActiveObject()->getId();
            $oRating = oxNew( 'oxrating' );
            $this->_blRate = $oRating->allowRating( $this->getReviewUserId(), $sType, $sObjectId);

        }
        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 getCrossSelling()
    {
        if ( $this->_oCrossSelling === null ) {
            $this->_oCrossSelling = false;
            if ( $oProduct = $this->getProduct() ) {
                $this->_oCrossSelling = $oProduct->getCrossSelling();
            }
        }
        return $this->_oCrossSelling;
    }

    public function getSimilarProducts()
    {
        if ( $this->_oSimilarProducts === null ) {
            $this->_oSimilarProducts = false;
            if ( $oProduct = $this->getProduct() ) {
                $this->_oSimilarProducts = $oProduct->getSimilarProducts();
            }
        }
        return $this->_oSimilarProducts;
    }

    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) oxConfig::getParameter( '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;
            if ( $this->_oActiveRecommList ) {
                $this->_oPageNavigation = $this->generatePageNavigation();
            }
        }
        return $this->_oPageNavigation;
    }

    public function getAdditionalParams()
    {
        $sAddParams = parent::getAdditionalParams();
        if ( $oActRecommList = $this->getActiveRecommList() ) {
            $sAddParams .= '&amp;recommid='.$oActRecommList->getId();
        }
        return $sAddParams;
    }
}

---