review.php

Go to the documentation of this file.

<?php

class Review extends Details
{
    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 getViewId()
    {
        return oxUBase::getViewId();
    }

    public function init()
    {
        if ( oxConfig::getParameter( 'recommid' ) && !$this->getActiveRecommList() ) {
            oxUtils::getInstance()->redirect( $this->getConfig()->getShopHomeURL() );
        }

        oxUBase::init();
    }

    public function render()
    {
        oxUBase::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'] = $oActiveRecommList = $this->getActiveRecommList();
        $this->_aViewData['itemList']       = $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 );
        }

        $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 ( $sReviewUserId && $this->canAcceptFormData() && $this->_checkDirectReview( $sReviewUserId ) ) {

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

                if ( ( $dRating = oxConfig::getParameter( 'rating' ) ) === null ) {
                    $dRating = oxConfig::getParameter( 'artrating' );
                }

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

                //save rating
                if ( $dRating !== null && $dRating >= 0 && $dRating <= 5 ) {
                    $oRating = oxNew( 'oxrating' );
                    if ( $oRating->allowRating( $sReviewUserId, $sType, $oActObject->getId() ) ) {
                        $oRating->oxratings__oxuserid   = new oxField( $sReviewUserId );
                        $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 ) oxConfig::getParameter( '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( oxLang::getInstance()->getBaseLanguage() );
                    $oReview->oxreviews__oxuserid   = new oxField( $sReviewUserId );
                    $oReview->oxreviews__oxrating   = new oxField( ( $dRating !== null ) ? $dRating : null );
                    $oReview->save();

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

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

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

    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' );
                $this->_sReviewUserId = $sReviewUser;
            } elseif ( ( $oUser = $this->getUser() ) ) {
                $this->_sReviewUserId = $oUser->getId();
            }
        }
        return $this->_sReviewUserId;
    }

    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';
        } elseif ( $this->getActiveRecommList() ) {
            $sType = 'oxrecommlist';
        }
        return $sType;
    }

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

        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;
            if ( ( $oActObject = $this->_getActiveObject() ) ) {
                $oRating = oxNew( 'oxrating' );
                $this->_blRate = $oRating->allowRating( $this->getReviewUserId(), $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) 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->getActiveRecommList() ) {
                $this->_oPageNavigation = $this->generatePageNavigation();
            }
        }
        return $this->_oPageNavigation;
    }

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

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

        if ( $sCnId = oxConfig::getParameter( 'cnid' ) ) {
            $sParams .= "&amp;cnid={$sCnId}";
        }
        if ( $sAnId = oxConfig::getParameter( 'anid' ) ) {
            $sParams .= "&amp;anid={$sAnId}";
        }
        if ( $sListType = oxConfig::getParameter( 'listtype' ) ) {
            $sParams .= "&amp;listtype={$sListType}";
        }
        if ( $sRecommId = oxConfig::getParameter( 'recommid' ) ) {
            $sParams .= "&amp;recommid={$sRecommId}";
        }

        return $sParams;
    }
}