recommlist.php

Go to the documentation of this file.

<?php

class RecommList extends aList
{
    protected $_sListType = 'recommlist';

    protected $_sThisTemplate = 'recommlist.tpl';

    protected $_oOtherRecommList = null;

    protected $_aReviews = null;

    protected $_blRate = null;

    protected $_dRatingValue = null;

    protected $_iRatingCnt = null;

    protected $_oSearchRecommLists = null;

    protected $_sSearch = null;

    protected $_sTplLocation = null;

    protected $_oPageNavigation = null;

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

        $this->_iAllArtCnt = 0;
        $this->_aViewData['actvrecommlist'] = $this->getActiveRecommList();
        $this->_aViewData['itemList'] = $this->getArticleList();

        // loading other recommlists
        $this->_aViewData['similarrecommlist'] = $this->getSimilarRecommLists();

        // Loads rating parameters
        $this->_aViewData['rate']      = $this->canRate();
        $this->_aViewData['rating']    = $this->getRatingValue();
        $this->_aViewData['ratingcnt'] = $this->getRatingCount();
        $this->_aViewData['reviews']   = $this->getReviews();

        // list of found oxrecommlists
        $this->_aViewData['recommlists'] = $this->getRecommLists();
        if ( $oActiveRecommList = $this->getActiveRecommList() ) {
            if ( ( $oList = $this->getArticleList() ) && $oList->count()) {
                $this->_iAllArtCnt = $oActiveRecommList->getArtCount();
            }

            if ( $myConfig->getConfigParam( 'bl_rssRecommListArts' ) ) {
                $oRss = oxNew('oxrssfeed');
                $this->addRssFeed($oRss->getRecommListArticlesTitle($oActiveRecommList), $oRss->getRecommListArticlesUrl($this->_oActiveRecommList), 'recommlistarts');
            }

        } else {
            if ( ( $oList = $this->getRecommLists() ) && $oList->count() ) {
                $oRecommList = oxNew( 'oxrecommlist' );
                $this->_iAllArtCnt = $oRecommList->getSearchRecommListCount( $this->getRecommSearch() );
            }
        }

        if ( !( $oList = $this->getArticleList() ) ) {
            $oList = $this->getRecommLists();
        }

        if ( $oList && $oList->count() ) {
            $iNrofCatArticles = (int) $this->getConfig()->getConfigParam( 'iNrofCatArticles' );
            $iNrofCatArticles = $iNrofCatArticles ? $iNrofCatArticles : 10;
            $this->_iCntPages  = round( $this->_iAllArtCnt / $iNrofCatArticles + 0.49 );
        }

        $this->_aViewData['pageNavigation'] = $this->getPageNavigation();
        $this->_aViewData['template_location']   = $this->getTemplateLocation();
        $this->_aViewData['searchrecomm']        = $this->getRecommSearch();
        $this->_aViewData['searchrecommforhtml'] = $this->getSearchForHtml();

        $this->_aViewData['loginformanchor'] = $this->getLoginFormAnchor();

        // processing list articles
        $this->_processListArticles();

        return $this->_sThisTemplate;
    }

    protected function _getProductLinkType()
    {
        return OXARTICLE_LINKTYPE_RECOMM;
    }

    public function getAddUrlParams()
    {
        $sAddParams  = parent::getAddUrlParams();
        $sAddParams .= ($sAddParams?'&amp;':'') . "listtype={$this->_sListType}";

        if ( $oRecommList = $this->getActiveRecommList() ) {
            $sAddParams .= "&amp;recommid=".$oRecommList->getId();
        }

        return $sAddParams;
    }

    public function getAddSeoUrlParams()
    {
        $sAddParams = parent::getAddSeoUrlParams();
        if ( $sParam = oxConfig::getParameter( "searchrecomm", true ) ) {
            $sAddParams .= "&amp;searchrecomm=" . rawurlencode( $sParam );
        }
        return $sAddParams;
    }

    public function saveReview()
    {
        if ( $this->canAcceptFormData() &&
             ( $oRecommList = $this->getActiveRecommList() ) && ( $oUser = $this->getUser() ) ) {

            //save rating
            $dRating = oxConfig::getParameter( 'recommlistrating' );
            if ( $dRating !== null ) {
                $dRating = (int) $dRating;
            }

            if ( $dRating !== null && $dRating >= 0 && $dRating <= 5 ) {
                $oRating = oxNew( 'oxrating' );
                if ( $oRating->allowRating( $oUser->getId(), 'oxrecommlist', $oRecommList->getId() ) ) {
                    $oRating->oxratings__oxuserid   = new oxField( $oUser->getId() );
                    $oRating->oxratings__oxtype     = new oxField( 'oxrecommlist' );
                    $oRating->oxratings__oxobjectid = new oxField( $oRecommList->getId() );
                    $oRating->oxratings__oxrating   = new oxField( $dRating );
                    $oRating->save();
                    $oRecommList->addToRatingAverage( $dRating );
                }
            }

            if ( ( $sReviewText = trim( ( string ) oxConfig::getParameter( 'rvw_txt', true ) ) ) ) {
                $oReview = oxNew( 'oxreview' );
                $oReview->oxreviews__oxobjectid = new oxField( $oRecommList->getId() );
                $oReview->oxreviews__oxtype     = new oxField( 'oxrecommlist' );
                $oReview->oxreviews__oxtext     = new oxField( $sReviewText, oxField::T_RAW );
                $oReview->oxreviews__oxlang     = new oxField( oxLang::getInstance()->getBaseLanguage() );
                $oReview->oxreviews__oxuserid   = new oxField( $oUser->getId() );
                $oReview->oxreviews__oxrating   = new oxField( ( $dRating !== null ) ? $dRating : null );
                $oReview->save();
            }
        }
    }

    public function showLogin()
    {
        $this->_sThisTemplate = 'account_login.tpl';
        $this->_sLoginFormAnchor = "review";
    }

    public function getNavigationParams()
    {
        $aParams = oxUBase::getNavigationParams();
        $aParams['recommid'] = oxConfig::getParameter( 'recommid' );

        return $aParams;
    }

    public function getActiveRecommItems()
    {
        return $this->getArticleList();
    }

    public function getArticleList()
    {
        if ( $this->_aArticleList === null ) {
            $this->_aArticleList = 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;

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

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

    public function getSimilarRecommLists()
    {
        if ( $this->_oOtherRecommList === null ) {
            $this->_oOtherRecommList = false;
            if ( ( $oActiveRecommList = $this->getActiveRecommList() ) && ( $oList = $this->getArticleList() ) ) {
                $oRecommLists = $oActiveRecommList->getRecommListsByIds( $oList->arrayKeys());
                //do not show the same list
                unset( $oRecommLists[$oActiveRecommList->getId()] );
                $this->_oOtherRecommList = $oRecommLists;
            }
        }
        return $this->_oOtherRecommList;
    }

    public function getRecommId()
    {
        return oxConfig::getParameter( 'recommid' );
    }

    public function getReviews()
    {
        if ( $this->_aReviews === null ) {
            $this->_aReviews = false;
            if ( $this->isReviewActive() && ( $oActiveRecommList = $this->getActiveRecommList() ) ) {
                $this->_aReviews = $oActiveRecommList->getReviews();
            }
        }
        return $this->_aReviews;
    }

    public function isReviewActive()
    {
        return $this->getConfig()->getConfigParam( 'bl_perfLoadReviews' );
    }

    public function canRate()
    {
        if ( $this->_blRate === null ) {
            $this->_blRate = false;
            if ( $this->isReviewActive() && ( $oActiveRecommList = $this->getActiveRecommList() ) ) {
                $oRating = oxNew( 'oxrating' );
                $this->_blRate = $oRating->allowRating( oxSession::getVar( 'usr' ), 'oxrecommlist', $oActiveRecommList->getId());
            }
        }
        return $this->_blRate;
    }

    public function getRatingValue()
    {
        if ( $this->_dRatingValue === null ) {
            $this->_dRatingValue = (double)0;
            if ( $this->isReviewActive() && ( $oActiveRecommList = $this->getActiveRecommList() ) ) {
                $this->_dRatingValue = round( $oActiveRecommList->oxrecommlists__oxrating->value, 1);
            }
        }
        return (double) $this->_dRatingValue;
    }

    public function getRatingCount()
    {
        if ( $this->_iRatingCnt === null ) {
            $this->_iRatingCnt = false;
            if ( $this->isReviewActive() && ( $oActiveRecommList = $this->getActiveRecommList() ) ) {
                $this->_iRatingCnt = $oActiveRecommList->oxrecommlists__oxratingcnt->value;
            }
        }
        return $this->_iRatingCnt;
    }

    public function getRecommLists()
    {
        if ( $this->_oSearchRecommLists === null ) {
            $this->_oSearchRecommLists = array();
            if ( !$this->getActiveRecommList() ) {
                // list of found oxrecommlists
                $oRecommList = oxNew( 'oxrecommlist' );
                $oList = $oRecommList->getSearchRecommLists( $this->getRecommSearch() );
                if ( $oList && $oList->count() ) {
                    $this->_oSearchRecommLists = $oList;
                }
            }
        }
        return $this->_oSearchRecommLists;
    }

    public function getRecommSearch()
    {
        if ( $this->_sSearch === null ) {
            $this->_sSearch = false;
            if ( $sSearch = oxConfig::getParameter( 'searchrecomm', true ) ) {
                $this->_sSearch = $sSearch;
            }
        }
        return $this->_sSearch;
    }

    public function getTemplateLocation()
    {
        if ( $this->_sTplLocation === null ) {
            $this->_sTplLocation = false;
            $oLang = oxLang::getInstance();
            if ( $sSearchparam = $this->getRecommSearch() ) {
                $sUrl = $this->getConfig()->getShopHomeURL();
                $sLink = "{$sUrl}cl=recommlist&amp;searchrecomm=".rawurlencode( $sSearchparam );
                $sTitle = $oLang->translateString('RECOMMLIST');
                $sTitle .= " / ".$oLang->translateString('RECOMMLIST_SEARCH').' "'.$sSearchparam.'"';
                $this->_sTplLocation = "<a href='".$sLink."'>".$sTitle."</a>";
            } else {
                $this->_sTplLocation = $oLang->translateString('RECOMMLIST');
            }
        }
        return $this->_sTplLocation;
    }

    public function getTreePath()
    {
        $oLang = oxLang::getInstance();

        $aPath[0] = oxNew( "oxcategory" );
        $aPath[0]->setLink( false );
        $aPath[0]->oxcategories__oxtitle = new oxField( $oLang->translateString('RECOMMLIST') );

        if ( $sSearchparam = $this->getRecommSearch() ) {
            $sUrl   = $this->getConfig()->getShopHomeURL()."cl=recommlist&amp;searchrecomm=".rawurlencode( $sSearchparam );
            $sTitle = $oLang->translateString('RECOMMLIST_SEARCH').' "'.$sSearchparam.'"';

            $aPath[1] = oxNew( "oxcategory" );
            $aPath[1]->setLink( $sUrl );
            $aPath[1]->oxcategories__oxtitle = new oxField( $sTitle );
        }

        return $aPath;
    }

    public function getSearchForHtml()
    {
        // #M1450 if active recommlist is loaded return it's title
        if ( $oActiveRecommList = $this->getActiveRecommList()) {
            return $oActiveRecommList->oxrecommlists__oxtitle->value;
        }
        return oxConfig::getParameter( 'searchrecomm' );
    }

    public function getLoginFormAnchor()
    {
        return $this->_sLoginFormAnchor;
    }

    public function generatePageNavigationUrl()
    {
        if ( ( oxUtils::getInstance()->seoIsActive() && ( $oRecomm = $this->getActiveRecommList() ) ) ) {
            $sUrl = $oRecomm->getLink();
        } else {
            $sUrl = oxUBase::generatePageNavigationUrl();
        }
        return $sUrl;
    }

    protected function _addPageNrParam( $sUrl, $iPage, $iLang = null)
    {
        if ( oxUtils::getInstance()->seoIsActive() && ( $oRecomm = $this->getActiveRecommList() ) ) {
            if ( $iPage ) {
                // only if page number > 0
                $sUrl = oxSeoEncoderRecomm::getInstance()->getRecommPageUrl( $oRecomm, $iPage, $iLang, true );
            }
        } else {
            $sUrl = oxUBase::_addPageNrParam( $sUrl, $iPage, $iLang );
        }
        return $sUrl;
    }

    public function getAdditionalParams()
    {
        $sAddParams = oxUBase::getAdditionalParams();

        if ( $oRecomm = $this->getActiveRecommList() ) {
            $sAddParams .= "&amp;recommid=".$oRecomm->getId();
        }

        if ( $sSearch = $this->getRecommSearch() ) {
            $sAddParams .= "&amp;searchrecomm=". rawurlencode( $sSearch );
        }

        return $sAddParams;
    }

    public function getLink( $iLang = null )
    {
        if ( $oRecomm = $this->getActiveRecommList() ) {
            $sLink = $oRecomm->getLink( $iLang );
        } else {
            $sLink = oxUBase::getLink( $iLang );
        }
        $sSearch = oxConfig::getParameter( 'searchrecomm' );
        if ( $sSearch ) {
            $sLink .= ( ( strpos( $sLink, '?' ) === false ) ? '?' : '&amp;' ) . "searchrecomm={$sSearch}";
        }

        return $sLink;
    }
}