recommlist.php

Go to the documentation of this file.

<?php

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

    protected $_sThisTemplate = 'recommlist.tpl';

    protected $_sRecommId = null;

    protected $_oActiveRecommList = null;

    protected $_oActiveRecommItems = null;

    protected $_oOtherRecommList = null;

    protected $_aReviews = null;

    protected $_blReviewActive = 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()
    {
        parent::render();
        $myConfig = $this->getConfig();

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

        // 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 ( $sOxid = $this->getRecommId()) {
            $oActiveRecommList = $this->getActiveRecommList();
            $oList = $this->getActiveRecommItems();
            if ( $oList && $oList->count()) {
                    $this->_iAllArtCnt = $oActiveRecommList->getArtCount();
            }

            if (in_array('oxrss_recommlistarts', $myConfig->getConfigParam( 'aRssSelected' ))) {
                $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->getActiveRecommItems() ) {
            $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 _processListArticles()
    {
        $sAddParams = $this->getAddUrlParams();
        if ( $sAddParams && $this->_oActiveRecommItems ) {
            foreach ( $this->_oActiveRecommItems as $oArticle ) {
                $oArticle->appendLink( $sAddParams );
            }
        }
    }

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

        if ( $sParam = rawurlencode( oxConfig::getParameter( 'searchrecomm', true ) ) ) {
            $sAddParams .= "&amp;searchrecomm={$sParam}";
        }

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

        return $sAddParams;
    }

    public function saveReview()
    {
        $sReviewText = trim( ( string ) oxConfig::getParameter( 'rvw_txt', true ) );
        $dRating     = oxConfig::getParameter( 'recommlistrating' );
        if ( $dRating < 0 || $dRating > 5 ) {
            $dRating = null;
        }

        $sRLId  = oxConfig::getParameter( 'recommid' );
        $sUserId = oxSession::getVar( 'usr' );

        $oRecommList = oxNew('oxrecommlist');
        if (!$oRecommList->load($sRLId)) {
            return;
        }

        //save rating
        if ( $dRating && $sUserId ) {
            $oRating = oxNew( 'oxrating' );
            $blRate = $oRating->allowRating( $sUserId, 'oxrecommlist', $oRecommList->getId());
            if ( $blRate) {
                $oRating->oxratings__oxuserid   = new oxField($sUserId);
                $oRating->oxratings__oxtype     = new oxField('oxrecommlist', oxField::T_RAW);
                $oRating->oxratings__oxobjectid = new oxField($sRLId);
                $oRating->oxratings__oxrating   = new oxField($dRating);
                $oRating->save();
                $oRecommList->addToRatingAverage( $dRating);
            } else {
                $dRating = null;
            }
        }

        if ( $sReviewText && $sUserId ) {
            $oReview = oxNew( 'oxreview' );
            $oReview->oxreviews__oxobjectid = new oxField($sRLId);
            $oReview->oxreviews__oxtype     = new oxField('oxrecommlist', oxField::T_RAW);
            $oReview->oxreviews__oxtext     = new oxField($sReviewText, oxField::T_RAW);
            $oReview->oxreviews__oxlang     = new oxField(oxLang::getInstance()->getBaseLanguage());
            $oReview->oxreviews__oxuserid   = new oxField($sUserId);
            $oReview->oxreviews__oxrating   = new oxField(( $dRating) ? $dRating : null);
            $oReview->save();
        }
    }

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

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

        return $aParams;
    }

    public function getActiveRecommList()
    {
        if ( $this->_oActiveRecommList === null ) {
            $this->_oActiveRecommList = false;
            if ( $sOxid = $this->getRecommId()) {
                $this->_oActiveRecommList = oxNew( 'oxrecommlist' );
                $this->_oActiveRecommList->load( $sOxid);
            }
        }
        return $this->_oActiveRecommList;
    }

    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 getSimilarRecommLists()
    {
        if ( $this->_oOtherRecommList === null ) {
            $this->_oOtherRecommList = false;
            if ( $oActiveRecommList = $this->getActiveRecommList() ) {
                if ( $oList = $this->getActiveRecommItems() ) {
                    $oRecommLists  = $oActiveRecommList->getRecommListsByIds( $oList->arrayKeys());
                    //do not show the same list
                    unset($oRecommLists[$this->getRecommId()]);
                    $this->_oOtherRecommList = $oRecommLists;
                }
            }
        }
        return $this->_oOtherRecommList;
    }

    public function getRecommId()
    {
        if ( $this->_sRecommId === null ) {
            $this->_sRecommId = false;
            if ( $sOxid = oxConfig::getParameter( 'recommid' )) {
                $this->_sRecommId = $sOxid;
            }
        }
        return $this->_sRecommId;
    }

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

    public function isReviewActive()
    {
        $myConfig  = $this->getConfig();
        if ( $this->_blReviewActive === null ) {
            $this->_blReviewActive = false;
            if ( $myConfig->getConfigParam( 'bl_perfLoadReviews' ) ) {
                $this->_blReviewActive = true;
            }
        }
        return $this->_blReviewActive;
    }

    public function canRate()
    {
        if ( $this->_blRate === null ) {
            $this->_blRate = false;
            if ( $this->isReviewActive() ) {
                if ( $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 = false;
            if ( $this->isReviewActive() ) {
                if ( $oActiveRecommList = $this->getActiveRecommList() ) {
                    $this->_dRatingValue = round( $oActiveRecommList->oxrecommlists__oxrating->value, 1);
                }
            }
        }
        return $this->_dRatingValue;
    }

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

    public function getRecommLists()
    {
        if ( $this->_oSearchRecommLists === null ) {
            $this->_oSearchRecommLists = array();
            if ( !$this->getRecommId()) {
                $sSearch = $this->getRecommSearch();
                // list of found oxrecommlists
                $oRecommList = oxNew( 'oxrecommlist' );
                $oList = $oRecommList->getSearchRecommLists( $sSearch );
                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()
    {
        return oxConfig::getParameter( 'searchrecomm' );
    }

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

    public function getPageNavigation()
    {
        if ( $this->_oPageNavigation === null ) {
            $this->_oPageNavigation = false;
            $this->_oPageNavigation = $this->generatePageNavigation();
        }
        return $this->_oPageNavigation;
    }

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

        if ( $sOxid = $this->getRecommId() ) {
            $sAddParams .= "&amp;recommid={$sOxid}";
        }

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

        return $sAddParams;
    }

    public function getLink( $iLang = null )
    {
        $sLink = parent::getLink( $iLang );

        if ( oxUtils::getInstance()->seoIsActive() ) {
            if ( $sRecommId = $this->getRecommId() ) {
                $sLink .= ( ( strpos( $sLink, '?' ) === false ) ? '?' : '&amp;' ) . "recommid={$sRecommId}";
            }

            if ( $sSearch = $this->getSearchForHtml() ) {
                $sLink .= ( ( strpos( $sLink, '?' ) === false ) ? '?' : '&amp;' ) . "searchrecomm={$sSearch}";
            }
        }

        return $sLink;
    }
}

---