oxview.php

Go to the documentation of this file.

<?php

class oxView extends oxSuperCfg
{
    protected $_oaComponents = array();

    protected $_aViewData = array();

    protected $_sClassLocation = null;

    protected $_sThisAction = null;

    protected $_oParent = null;

    protected $_blIsOrderStep = false;

    protected $_blIsComponent = false;

    protected $_oActCategory = null;

    protected $_oActVendor = null;

    protected $_oActSearch = null;

    protected $_sThisTemplate = null;

    protected $_aComponentNames = array();

    protected $_blIsCallForCache = false;

    protected $_sViewId = null;

    protected $_sListType = null;

    protected $_sCategoryId = null;

    protected $_sClass = null;

    protected $_sFnc = null;

    protected static $_blExecuted = false;

    protected $_oClickCat = null;

    protected $_sAdditionalParams = null;

    protected $_blShowSorting = false;

    protected $_blShowRightBasket = null;

    protected $_blShowLeftBasket = null;

    protected $_blShowTopBasket = null;

    protected $_blLoadCurrency = null;

    protected $_blLoadVendorTree = null;

    protected $_blDontShowEmptyCats = null;

    protected $_sTrustedShopId = null;

    protected $_blLoadLanguage = null;

    protected $_blShowTopCatNav = null;

    protected $_iTopCatNavItmCnt = null;

    protected $_sCharSet = null;

    protected $_sVersion = null;

    protected $_blDemoVersion = null;

    protected $_blDemoShop = null;

    protected $_aRssLinks = null;

    protected $_blActiveSorting = null;

    protected $_sListOrderBy = null;

    protected $_sListOrderDir = null;

    protected $_sMetaDescription = null;

    protected $_sMetaKeywords = null;

    protected $_oActCurrency = null;

    protected $_iCompItemsCnt = null;

    protected $_sWishlistName = null;

    protected $_aMenueList = null;

    protected $_iViewIndexState = 0;

    protected $_iNewsStatus = null;

    protected $_sShopLogo = null;

    public function init()
    {
        // setting current view class name
        $this->_sThisAction = strtolower( get_class( $this ) );

        if ( !$this->_blIsComponent ) {
            // storing current view

            $blInit = true;


            // init all components if there are any
            foreach ( $this->_aComponentNames as $sComponentName => $blNotCacheable ) {
                // do not override initiated components
                if ( !isset( $this->_oaComponents[$sComponentName] ) ) {
                    // component objects MUST be created to support user called functions
                    $oComponent = oxNew( $sComponentName );
                    $oComponent->setParent( $this );
                    $oComponent->setThisAction( $sComponentName );
                    $this->_oaComponents[$sComponentName] = $oComponent;
                }

                // do we really need to initiate them ?
                if ( $blInit ) {
                    $this->_oaComponents[$sComponentName]->init();

                    // executing only is view does not have action method
                    if ( !method_exists( $this, $this->getFncName() ) ) {
                        $this->_oaComponents[$sComponentName]->executeFunction( $this->getFncName() );
                    }
                }
            }

            // assume that cached components does not affect this method ...
            $this->addGlobalParams();

            // enable sorting ?
            if ( $this->showSorting() ) {
                $this->prepareSortColumns();
            }
            $this->_aViewData['showsorting']    = $this->isSortingActive();
            $this->_aViewData["allsortcolumns"] = $this->getSortColumns();
            $this->_aViewData['listorderby']    = $this->getListOrderBy();
            $this->_aViewData['listorder']      = $this->getListOrderDirection();
        }
    }

    public function showSorting()
    {
        return $this->_blShowSorting && $this->getConfig()->getConfigParam( 'blShowSorting' );
    }

    public function getViewId()
    {
        if ( $this->_sViewId ) {
            return $this->_sViewId;
        }

        //$iLang = (int) oxConfig::getParameter( 'language' );
        $iLang = oxLang::getInstance()->getBaseLanguage();

        $iCur  = (int) oxConfig::getParameter( 'currency' );


            $this->_sViewId =  "ox|$iLang|$iCur";

        return $this->_sViewId;
    }


    public function getViewResetId()
    {
        if ( $this->_sViewResetID ) {
            return $this->_sViewResetID;
        }

        $sCategoryID = $this->_oClickCat?$this->_oClickCat->getId():'-';
        $this->_sViewResetID =  "ox|cid={$sCategoryID}|cl=".$this->getClassName();
        return $this->_sViewResetID;
    }


    public function render()
    {
        $this->_aViewData['meta_description'] = $this->getMetaDescription();
        $this->_aViewData['meta_keywords']    = $this->getMetaKeywords();

        // only if this is no component
        if ( !$this->_blIsComponent ) {
            foreach ( array_keys( $this->_oaComponents ) as $sComponentName ) {
                $this->_aViewData[$sComponentName] = $this->_oaComponents[$sComponentName]->render();
            }

            // set url and form navigation string
            $this->_setNavigationParams();
        }

        return $this->_sThisTemplate;
    }

    public function addGlobalParams( $oShop = null)
    {
        $mySession  = $this->getSession();
        $myConfig   = $this->getConfig();

        //deprecated template vars

        $this->_aViewData['isnewsletter'] = true;
        $this->_aViewData['isvarianten'] = true;
        $this->_aViewData['isreview'] = true;
        $this->_aViewData['isaddsales'] = true;
        $this->_aViewData['isvoucher'] = true;
        $this->_aViewData['isdtaus'] = true;
        $this->_aViewData['ispricealarm'] = true;
        $this->_aViewData['iswishlist'] = true;
        $this->_aViewData['isipayment'] = true;
        $this->_aViewData['istrusted'] = true;
        $this->_aViewData['isfiltering'] = true;
        $this->_aViewData['isgooglestats'] = true;
        $this->_aViewData['iswishlist'] = true;
        $this->_aViewData['isstaffelpreis'] = true;

        // by default we allways display newsletter bar
        $this->_iNewsStatus = 1;

        $this->_aViewData['charset']       = $this->getCharSet();
        $this->_aViewData['version']       = $this->getShopVersion();
        $this->_aViewData['edition']       = $this->getShopEdition();
        $this->_aViewData['fulledition']   = $this->getShopFullEdition();
        $this->_aViewData['isdemoversion'] = $this->isDemoVersion();

        $this->_aViewData['isfiltering'] = true;

        // show baskets
        $this->_aViewData['bl_perfShowLeftBasket']  = $this->showLeftBasket();
        $this->_aViewData['bl_perfShowRightBasket'] = $this->showRightBasket();
        $this->_aViewData['bl_perfShowTopBasket']   = $this->showTopBasket();

        // allow currency swiching
        $this->_aViewData['bl_perfLoadCurrency'] = $this->loadCurrency();

        // show/hide vendors
        $this->_aViewData['bl_perfLoadVendorTree'] = $this->loadVendorTree();

        // show/hide empty categories
        $this->_aViewData['blDontShowEmptyCategories'] = $this->dontShowEmptyCategories();

        $this->_aViewData['iShopID_TrustedShops'] = $this->getTrustedShopId();

        // used for compatibility with older templates
        $this->_aViewData['fixedwidth'] = $myConfig->getConfigParam( 'blFixedWidthLayout' );
        $this->_aViewData['urlsign']    = '&';
        $this->_aViewData['wishid']    = oxConfig::getParameter( 'wishid' );
        $this->_aViewData['shownewbasketmessage'] = oxUtils::getInstance()->isSearchEngine()?0:$myConfig->getConfigParam( 'iNewBasketItemMessage' );

        $this->_aViewData['sListType'] = $this->getListType();

        // set additional params
        $this->_setAdditionalParams();
        $this->_aViewData["additionalparams"] = $this->getAdditionalParams();

        $this->_aViewData['bl_perfLoadLanguage'] = $this->isLanguageLoaded();

        // new navigation ?
        $this->_aViewData['showtopcatnavigation']   = $this->showTopCatNavigation();
        $this->_aViewData['topcatnavigationitmcnt'] = $this->getTopNavigationCatCnt();

        $this->_setNrOfArtPerPage();

        // assigning shop to view config ..
        $oViewConf = $this->getViewConfig();
        if ( $oShop ) {
            $oViewConf->setViewShop( $oShop, $this->_aViewData );
        }

        //sending all view to smarty
        $this->_aViewData['oView'] = $this;
        $this->_aViewData['oViewConf'] = $this->getViewConfig();

        // @deprecated
        $this->_aViewData['shop'] = $this->getViewConfig();

        return $oViewConf;
    }

    public function addRssFeed($sTitle, $sUrl, $key = null)
    {
        if (!is_array($this->_aRssLinks)) {
            $this->_aRssLinks = array();
        }
        if ($key === null) {
            $this->_aRssLinks[] = array('title'=>$sTitle, 'link' => $sUrl);
        } else {
            $this->_aRssLinks[$key] = array('title'=>$sTitle, 'link' => $sUrl);
        }

        $this->_aViewData['rsslinks'] = $this->getRssLinks();
    }

    public function addTplParam( $sPara, $sValue )
    {
        $this->_aViewData[$sPara] = $sValue;
    }

    public function prepareSortColumns()
    {
        $aSortColumns = $this->getConfig()->getConfigParam( 'aSortCols' );
        if ( count( $aSortColumns ) > 0 ) {

            $this->_blActiveSorting = true;
            $this->_aSortColumns = $aSortColumns;

            $sCnid = oxConfig::getParameter( 'cnid' );

            $sSortBy  = oxConfig::getParameter( 'listorderby' );
            $sSortDir = oxConfig::getParameter( 'listorder' );

            if ( !$sSortBy && $aSorting = $this->getSorting( $sCnid ) ) {
                $sSortBy  = $aSorting['sortby'];
                $sSortDir = $aSorting['sortdir'];
            }

            if ( $sSortBy && oxDb::getInstance()->isValidFieldName( $sSortBy ) &&
                 $sSortDir && oxUtils::getInstance()->isValidAlpha( $sSortDir ) ) {

                $this->_sListOrderBy  = $sSortBy;
                $this->_sListOrderDir = $sSortDir;

                // caching sorting config
                $this->setItemSorting( $sCnid, $sSortBy, $sSortDir );
            }
        }
    }

    protected function _setAdditionalParams()
    {
        // #1018A
        $this->_sAdditionalParams = 'cl='.$this->getConfig()->getActiveView()->getClassName();

        // #1834M - specialchar search
        $sSearchParamForLink = rawurlencode( oxConfig::getParameter( 'searchparam', true ) );
        if ( isset( $sSearchParamForLink ) ) {
            $this->_sAdditionalParams .= "&amp;searchparam={$sSearchParamForLink}";
        }

        if ( ( $sVar = oxConfig::getParameter( 'searchcnid' ) ) ) {
            $this->_sAdditionalParams .= '&amp;searchcnid='.rawurlencode( rawurldecode( $sVar ) );
        }
        if ( ( $sVar = oxConfig::getParameter( 'searchvendor' ) ) ) {
            $this->_sAdditionalParams .= '&amp;searchvendor='.rawurlencode( rawurldecode( $sVar ) );
        }
        if ( ( $sVar = oxConfig::getParameter( 'cnid' ) ) ) {
            $this->_sAdditionalParams .= '&amp;cnid='.rawurlencode( rawurldecode( $sVar ) );
        }
    }

    public function getViewConfig()
    {
        if ( $this->_oViewConf === null ) {
            $this->_oViewConf = oxNew( 'oxViewConfig' );
        }

        return $this->_oViewConf;
    }

    protected function _setNrOfArtPerPage()
    {
        $myConfig  = $this->getConfig();
        $aViewData = array();

        //setting default values to avoid possible errors showing article list
        $iNrofCatArticles = $myConfig->getConfigParam( 'iNrofCatArticles' );
        $iNrofCatArticles = ( $iNrofCatArticles) ? $iNrofCatArticles : 10;

        // checking if all needed data is set
        $aNrofCatArticles = $myConfig->getConfigParam( 'aNrofCatArticles' );
        if ( !is_array( $aNrofCatArticles ) || !isset( $aNrofCatArticles[0] ) ) {
            $myConfig->setConfigParam( 'aNrofCatArticles', array( $iNrofCatArticles ) );
        } else {
            $iNrofCatArticles = $aNrofCatArticles[0];
        }

        $oViewConf = $this->getViewConfig();
        //value from user input
        if ( ( $iUserArtPerPage = (int) oxConfig::getParameter( '_artperpage' ) ) ) {
            // performing floor() to skip such variants as 7.5 etc
            $iNrofArticles = ( $iUserArtPerPage > 100 ) ? 10 : abs( $iUserArtPerPage );
            // M45 Possibility to push any "Show articles per page" number parameter
            $iNrofCatArticles = ( in_array( $iNrofArticles, $aNrofCatArticles ) ) ? $iNrofArticles : $iNrofCatArticles;
            $oViewConf->setViewConfigParam( 'iartPerPage', $iNrofCatArticles );
            oxSession::setVar( '_artperpage', $iNrofCatArticles );
        } elseif ( ( $iSessArtPerPage = oxSession::getVar( '_artperpage' ) )&& is_numeric( $iSessArtPerPage ) ) {
            // M45 Possibility to push any "Show articles per page" number parameter
            $iNrofCatArticles = ( in_array( $iSessArtPerPage, $aNrofCatArticles ) ) ? $iSessArtPerPage : $iNrofCatArticles;
            $oViewConf->setViewConfigParam( 'iartPerPage', $iSessArtPerPage );
            $iNrofCatArticles = $iSessArtPerPage;
        } else {
            $oViewConf->setViewConfigParam( 'iartPerPage', $iNrofCatArticles );
        }

        //setting number of articles per page to config value
        $myConfig->setConfigParam( 'iNrofCatArticles', $iNrofCatArticles );

        $this->_aViewData = array_merge( $this->_aViewData, $aViewData );
    }

    protected function _getSeoObjectId()
    {
    }

    public function setMetaDescription ( $aInput, $iLength = 1024, $blDescTag = false )
    {
        if ( oxUtils::getInstance()->seoIsActive() && ( $sOxid = $this->_getSeoObjectId() ) ) {

            // found special meta description ?
            if ( ( $sDescription = oxSeoEncoder::getInstance()->getMetaData( $sOxid , 'oxdescription' ) ) ) {
                return $this->_sMetaDescription = $sDescription;
            }

        }

        return $this->_sMetaDescription = $this->_prepareMetaDescription( $aInput, $iLength, $blDescTag );
    }

    protected function _prepareMetaDescription( $aInput, $iLength = 1024, $blDescTag = false )
    {
        /* performance - we dont need a huge amount of initial text.
           assume that effective text may be double longer than $iLength
           and simple turncate it
        */

        $sString = $aInput;
        if ( is_array( $aInput ) ) {
            $sString = implode( '  ', $aInput );
        }

        if ( $iLength != -1 ) {
            $iELength = ( $iLength * 2 );
            $sString = substr( $sString, 0, $iELength );
        }

        // decoding html entities
        $sString = html_entity_decode( $sString );
        // stripping HTML tags
        $sString = strip_tags( $sString );

        // removing some special chars
        $aRemoveChars = array( "\"", "'", ".", ":", "!", "?", "\n", "\r", "\t", "\x95", "\xA0", ";" );
        $sString = str_replace( $aRemoveChars, ' ', $sString );

        // removing duplicat words
        if ( !$blDescTag ) {
            $sString = $this->_removeDuplicatedWords( $sString );
        }

        // some special cases
        $sString = str_replace( ' ,', ',', $sString );
        $aPattern = array( "/,[\s\+\-\*]*,/", "/\s+,/" );
        $sString = preg_replace( $aPattern, ',', $sString );;
        $sString = oxUtilsString::getInstance()->minimizeTruncateString( $sString, $iLength );

        return $sString;
    }

    public function setMetaKeywords( $aInput )
    {
        if ( oxUtils::getInstance()->seoIsActive() && ( $sOxid = $this->_getSeoObjectId() )  ) {
            // found special meta description ?
            if ( ( $sKeywords = oxSeoEncoder::getInstance()->getMetaData( $sOxid, 'oxkeywords' ) ) ) {
                return $this->_sMetaKeywords = $sKeywords;
            }
        }

        return $this->_sMetaKeywords = $this->_prepareMetaKeyword( $aInput );
    }

    protected function _prepareMetaKeyword( $aInput )
    {
        $sString = $this->_prepareMetaDescription( $aInput, -1, true );
        $sString = $this->_removeDuplicatedWords( $sString );
        // removing in admin defined strings
        $aSkipTags = $this->getConfig()->getConfigParam( 'aSkipTags' );
        if ( is_array( $aSkipTags ) && $sString ) {
            foreach ( $aSkipTags as $sSkip ) {
                $aPattern = array( '/\W'.$sSkip.'\W/i', '/^'.$sSkip.'\W/i', '/\"'.$sSkip.'$/i' );
                $sString  = preg_replace( $aPattern, '', $sString);
            }
        }
        return $sString;
    }

    protected function _removeDuplicatedWords( $aInput )
    {
        if ( is_array( $aInput ) ) {
            $aStrings = $aInput;
        } else {
            //is String
            $aStrings = preg_split( "/[\s,]+/", $aInput );
        }

        foreach ( $aStrings as $iANum => $sAString ) {
            foreach ( $aStrings as $iBNum => $sBString ) {
                // duplicates
                if ( $sAString && $iANum != $iBNum && !strcasecmp( $sAString, $sBString ) ) {
                    unset( $aStrings[$iANum] );
                }
            }
        }

        return implode( ', ', $aStrings );
    }

    protected function _setNavigationParams()
    {
        $aParams = $this->_getNavigationParams();

        $aNavString['url']  = '';
        $aNavString['form'] = '';

        foreach ( $aParams as $sKey => $sValue ) {
            if ( $sValue ) {

                $aNavString['url'] .= '&amp;'.$sKey.'='.rawurlencode( $sValue );

                // get searchparam for form in different way
                if ( $sKey == 'searchparam' )
                    $sValue = oxConfig::getParameter( 'searchparam' );

                $aNavString['form'] .= "<input type=\"hidden\" name=\"$sKey\" value=\"$sValue\">\n";
            }
        }

        $oViewConf = $this->getViewConfig();
        $oViewConf->setViewConfigParam( 'navurlparams', $aNavString['url'] );
        $oViewConf->setViewConfigParam( 'navformparams', $aNavString['form'] );
    }

    protected function _getNavigationParams()
    {
        $aParams['cnid']     = $this->getCategoryId();
        $aParams['listtype'] = $this->getListType();

        $aParams['recommid']     = oxConfig::getParameter( 'recommid' );
        $aParams['searchrecomm'] = oxConfig::getParameter( 'searchrecomm', true );
        $aParams['searchparam']  = oxConfig::getParameter( 'searchparam', true );
        $aParams['searchcnid']   = oxConfig::getParameter( 'searchcnid' );
        $aParams['searchvendor'] = oxConfig::getParameter( 'searchvendor' );
        $aParams['searchtag']    = oxConfig::getParameter( 'searchtag', 1 );

        return $aParams;
    }

    public function getListType()
    {
        if ( $this->_sListType == null && ( $sListType = oxConfig::getParameter( 'listtype' ) ) ) {
            $this->_sListType = $sListType;
        }
        return $this->_sListType;
    }

    public function setListType( $sType )
    {
        $this->_sListType = $sType;
    }

    public function getCategoryId()
    {
        if ( $this->_sCategoryId == null && ( $sCatId = oxConfig::getParameter( 'cnid' ) ) ) {
            $this->_sCategoryId = $sCatId;
        }

        return $this->_sCategoryId;
    }

    public function setCategoryId( $sCategoryId )
    {
        $this->_sCategoryId = $sCategoryId;
    }

    public function getTemplateName()
    {
        return $this->_sThisTemplate;
    }

    public function setClassName( $sClassName )
    {
        $this->_sClass = $sClassName;
    }

    public function getClassName()
    {
        return $this->_sClass;
    }

    public function setFncName( $sFncName )
    {
        $this->_sFnc = $sFncName;
    }

    public function getFncName()
    {
        return $this->_sFnc;
    }

    public function setComponents( $aComponents = null )
    {
        $this->_oaComponents = $aComponents;
    }

    public function getComponents()
    {
        return $this->_oaComponents;
    }

    public function setViewData( $aViewData = null )
    {
        $this->_aViewData = $aViewData;
    }

    public function getViewData()
    {
        return $this->_aViewData;
    }

    public function getViewDataElement( $sParamId = null )
    {
        if ( $sParamId && isset( $this->_aViewData[$sParamId] ) ) {
            return $this->_aViewData[$sParamId];
        }
    }

    public function setClassLocation( $sClassLocation = null )
    {
        $this->_sClassLocation = $sClassLocation;
    }
    public function getClassLocation()
    {
        return $this->_sClassLocation;
    }

    public function setThisAction( $sThisAction = null )
    {
        $this->_sThisAction = $sThisAction;
    }

    public function getThisAction()
    {
        return $this->_sThisAction;
    }

    public function setParent( $oParent = null )
    {
        $this->_oParent = $oParent;
    }

    public function getParent()
    {
        return $this->_oParent;
    }

    public function setIsOrderStep( $blIsOrderStep = null )
    {
        $this->_blIsOrderStep = $blIsOrderStep;
    }

    public function getIsOrderStep()
    {
        return $this->_blIsOrderStep;
    }

    public function setIsComponent( $blIsComponent = null )
    {
        $this->_blIsComponent = $blIsComponent;
    }

    public function getIsComponent()
    {
        return $this->_blIsComponent;
    }

    public function setItemSorting( $sCnid, $sSortBy, $sSortDir = null )
    {
        $aSorting = oxSession::getVar( 'aSorting' );
        $aSorting[$sCnid]['sortby']  = $sSortBy;
        $aSorting[$sCnid]['sortdir'] = $sSortDir?$sSortDir:null;

        oxSession::setVar( 'aSorting', $aSorting );
    }

    public function getSorting( $sCnid )
    {
        $aSorting = oxSession::getVar( 'aSorting' );
        if ( isset( $aSorting[$sCnid] ) ) {
            return $aSorting[$sCnid];
        }
    }

    public function getSortingSql( $sCnid )
    {
        $aSorting = $this->getSorting( $sCnid );
        if ( is_array( $aSorting ) ) {
            return implode( " ", $aSorting );
        }
    }

    public function setIsCallForCache( $blIsCallForCache = null )
    {
        $this->_blIsCallForCache = $blIsCallForCache;
    }

    public function getIsCallForCache()
    {
        return $this->_blIsCallForCache;
    }

    public function executeFunction( $sFunction )
    {
        $sNewAction = null;

        // execute
        if ( $sFunction && !self::$_blExecuted ) {
            if ( method_exists( $this, $sFunction ) ) {


                $sNewAction = $this->$sFunction();
                self::$_blExecuted = true;
            }

            // was not executed on any level ?
            if ( !$this->_blIsComponent && !self::$_blExecuted ) {
                $oEx = oxNew( 'oxSystemComponentException' );
                $oEx->setMessage( 'EXCEPTION_SYSTEMCOMPONENT_FUNCTIONNOTFOUND' );
                $oEx->setComponent( $sFunction );
                throw $oEx;
            }
        }

        $this->_executeNewAction( $sNewAction );
    }

    protected function _executeNewAction( $sNewAction )
    {
        if ( $sNewAction ) {
            $myConfig  = $this->getConfig();

            // page parameters is the part which goes after '?'
            $aParams = explode( '?', $sNewAction );

            // action parameters is the part before '?'
            $sPageParams = isset( $aParams[1] )?$aParams[1]:null;

            // looking for function name
            $aParams    = explode( '/', $aParams[0] );
            $sClassName = $aParams[0];

            // looking for component name
            $aParams    = explode( '@', $aParams[0] );
            $sCmpName   = ( count( $aParams ) > 1 )?$aParams[0]:null;
            $sClassName = ( $sCmpName !== null )?$aParams[1]:$sClassName;

            // building redirect path ...
            $sHeader  = ( $sClassName )?"cl=$sClassName&":'';  // adding view name
            $sHeader .= ( $sPageParams )?"$sPageParams&":'';   // adding page params
            $sHeader .= $this->getSession()->sid();       // adding session Id

            // choosing URL to redirect
            $sURL = $myConfig->isSsl()?$myConfig->getSslShopUrl():$myConfig->getShopUrl();

            // different redirect URL in SEO mode
            if ( $this->isAdmin() ) {
                $sURL .= $myConfig->getConfigParam( 'sAdminDir' ) . '/';
            }

            $sURL = "{$sURL}index.php?{$sHeader}";

            //#M341 do not add redirect parameter
            oxUtils::getInstance()->redirect( $sURL, (bool) oxConfig::getParameter( 'redirected' ) );
        }
    }

    public function getAdditionalParams()
    {
        return $this->_sAdditionalParams;
    }

    public function noIndex()
    {
        if ( oxConfig::getParameter( 'cur' ) ) {
            return $this->_iViewIndexState = 1;
        }

        switch ( oxConfig::getParameter( 'fnc' ) ) {
            case 'tocomparelist':
            case 'tobasket':
                return $this->_iViewIndexState = 1;
            default: break;
        }
        return $this->_iViewIndexState;
    }

    public function getTitleSuffix()
    {
        return $this->getConfig()->getActiveShop()->oxshops__oxtitlesuffix->value;
    }

    public function getTitlePrefix()
    {
        return $this->getConfig()->getActiveShop()->oxshops__oxtitleprefix->value;
    }

    protected function getSubject()
    {
        return null;
    }

    public function getDynUrlParams()
    {
        $sRet = '';
        $sListType = $this->getListType();

        switch ($sListType) {
            default:
                break;
            case 'search':
                $sRet .= "&amp;listtype={$sListType}";
                if ( $sSearchParamForLink = rawurlencode( oxConfig::getParameter( 'searchparam', true ) ) ) {
                    $sRet .= "&amp;searchparam={$sSearchParamForLink}";
                }

                if ( ( $sVar = oxConfig::getParameter( 'searchcnid' ) ) ) {
                    $sRet .= '&amp;searchcnid='.rawurlencode( rawurldecode( $sVar ) );
                }
                if ( ( $sVar = oxConfig::getParameter( 'searchvendor' ) ) ) {
                    $sRet .= '&amp;searchvendor='.rawurlencode( rawurldecode( $sVar ) );
                }
               break;
        }

        return $sRet;
    }

    public function getLink($iLang = null)
    {
        if ( !isset( $iLang ) ) {
            $iLang = oxLang::getInstance()->getBaseLanguage();
        }

        $oDisplayObj = null;
        if ( oxUtils::getInstance()->seoIsActive() ) {
            $blTrySeo = true;
            $oDisplayObj = $this->getSubject();
        }

        if ( $oDisplayObj ) {
            return $oDisplayObj->getLink( $iLang );
        } else {
            $myConfig = oxConfig::getInstance();

            if ( $blTrySeo ) {
                $oEncoder = oxSeoEncoder::getInstance();
                if ( ( $sSeoUrl = $oEncoder->getStaticUrl( $myConfig->getShopHomeURL() . $this->_getSeoRequestParams(), $iLang ) ) ) {
                    return $sSeoUrl;
                }
            }

            $sForceLangChange = '';
            if ( oxLang::getInstance()->getBaseLanguage() != $iLang ) {
                $sForceLangChange = "&amp;lang={$iLang}";
            }

            // fallback to old non seo url
            return $myConfig->getShopCurrentURL( $iLang ) . $this->_getRequestParams() . $sForceLangChange;
        }
    }

    public function getSimilarRecommLists()
    {
        return null;
    }

    protected function _getRequestParams( $blAddPageNr  = true )
    {

        $sClass = $this->getClassName();
        $sFnc   = $this->getFncName();

        // #921 S
        $aFnc = array( 'tobasket', 'login_noredirect', 'addVoucher' );
        if ( in_array( $sFnc, $aFnc ) ) {
            $sFnc = '';
        }

        // #680
        $sURL = "cl={$sClass}";
        if ( $sFnc ) {
            $sURL       .= "&amp;fnc={$sFnc}";
        }
        if ( $sVal = oxConfig::getParameter( 'cnid' ) ) {
            $sURL       .= "&amp;cnid={$sVal}";
        }
        if ( $sVal= oxConfig::getParameter( 'anid' ) ) {
            $sURL .= "&amp;anid={$sVal}";
        }

        if ( $sVal = basename( oxConfig::getParameter( 'page' ) ) ) {
            $sURL       .= "&amp;page={$sVal}";
        }

        if ( $sVal = basename( oxConfig::getParameter( 'tpl' ) ) ) {
            $sURL       .= "&amp;tpl={$sVal}";
        }

        $iPgNr = (int) oxConfig::getParameter( 'pgNr' );
        // don't include page number for navigation
        // it will be done in oxubase::generatePageNavigation
        if ( $blAddPageNr && $iPgNr > 0 ) {
            $sURL .= "&amp;pgNr={$iPgNr}";
        }

        // #1184M - specialchar search
        if ( $sVal = rawurlencode( oxConfig::getParameter( 'searchparam', true ) ) ) {
            $sURL .= "&amp;searchparam={$sVal}";
        }

        if ( $sVal = oxConfig::getParameter( 'searchcnid' ) ) {
            $sURL .= "&amp;searchcnid={$sVal}";
        }

        if ( $sVal = oxConfig::getParameter( 'searchvendor' ) ) {
            $sURL .= "&amp;searchvendor={$sVal}";
        }

        if ( $sVal = oxConfig::getParameter( 'searchrecomm' ) ) {
            $sUrl .= "&amp;searchrecomm={$sVal}";
        }

        if ( $sVal = oxConfig::getParameter( 'searchtag' ) ) {
            $sUrl .= "&amp;searchtag={$sVal}";
        }

        if ( $sVal = oxConfig::getParameter( 'recommid' ) ) {
            $sURL .= "&amp;recommid={$sVal}";
        }

        return $sURL;
    }

    protected function _getSeoRequestParams()
    {

        $sClass = $this->getClassName();
        $sFnc   = $this->getFncName();

        // #921 S
        $aFnc = array( 'tobasket', 'login_noredirect', 'addVoucher' );
        if ( in_array( $sFnc, $aFnc ) ) {
            $sFnc = '';
        }

        // #680
        $sURL = "cl={$sClass}";
        if ( $sFnc ) {
            $sURL       .= "&amp;fnc={$sFnc}";
        }
        if ( $sVal = basename( oxConfig::getParameter( 'page' ) ) ) {
            $sURL       .= "&amp;page={$sVal}";
        }

        if ( $sVal = basename( oxConfig::getParameter( 'tpl' ) ) ) {
            $sURL       .= "&amp;tpl={$sVal}";
        }

        $iPgNr = (int) oxConfig::getParameter( 'pgNr' );
        if ( $iPgNr > 0 ) {
            $sURL .= "&amp;pgNr={$iPgNr}";
        }

        return $sURL;
    }

    public function showRightBasket()
    {
        if ( $this->_blShowRightBasket === null ) {
            if ( $blShowRightBasket = $this->getConfig()->getConfigParam( 'bl_perfShowRightBasket' ) )  {
                $this->_blShowRightBasket = $blShowRightBasket;
            }
        }
        return $this->_blShowRightBasket;
    }

    public function setShowRightBasket( $blShowBasket )
    {
        $this->_blShowRightBasket = $blShowBasket;
    }

    public function showLeftBasket()
    {
        if ( $this->_blShowLeftBasket === null ) {
            if ( $blShowLeftBasket = $this->getConfig()->getConfigParam( 'bl_perfShowLeftBasket' ) ) {
                $this->_blShowLeftBasket = $blShowLeftBasket;
            }
        }
        return $this->_blShowLeftBasket;
    }

    public function setShowLeftBasket( $blShowBasket )
    {
        $this->_blShowLeftBasket = $blShowBasket;
    }

    public function showTopBasket()
    {
        if ( $this->_blShowTopBasket === null ) {
            if ( $blShowTopBasket = $this->getConfig()->getConfigParam( 'bl_perfShowTopBasket' ) ) {
                $this->_blShowTopBasket = $blShowTopBasket;
            }
        }
        return $this->_blShowTopBasket;
    }

    public function setShowTopBasket( $blShowBasket )
    {
        $this->_blShowTopBasket = $blShowBasket;
    }

    public function loadCurrency()
    {
        if ( $this->_blLoadCurrency == null ) {
            $this->_blLoadCurrency = false;
            if ( $blLoadCurrency = $this->getConfig()->getConfigParam( 'bl_perfLoadCurrency' ) ) {
                $this->_blLoadCurrency = $blLoadCurrency;
            }
        }
        return $this->_blLoadCurrency;
    }

    public function loadVendorTree()
    {
        if ( $this->_blLoadVendorTree == null ) {
            $this->_blLoadVendorTree = false;
            if ( $blLoadVendorTree = $this->getConfig()->getConfigParam( 'bl_perfLoadVendorTree' ) ) {
                $this->_blLoadVendorTree = $blLoadVendorTree;
            }
        }
        return $this->_blLoadVendorTree;
    }

    public function dontShowEmptyCategories()
    {
        if ( $this->_blDontShowEmptyCats == null ) {
            $this->_blDontShowEmptyCats = false;
            if ( $blDontShowEmptyCats = $this->getConfig()->getConfigParam( 'blDontShowEmptyCategories' ) ) {
                $this->_blDontShowEmptyCats = $blDontShowEmptyCats;
            }
        }
        return $this->_blDontShowEmptyCats;
    }

    public function getTrustedShopId()
    {
        if ( $this->_sTrustedShopId == null && ( $aTrustedShopIds = $this->getConfig()->getConfigParam( 'iShopID_TrustedShops' ) ) ) {
            $iLangId = oxLang::getInstance()->getBaseLanguage();
            $this->_sTrustedShopId = $aTrustedShopIds[$iLangId];
        }
        return $this->_sTrustedShopId;
    }

    public function isLanguageLoaded()
    {
        if ( $this->_blLoadLanguage == null ) {
            $this->_blLoadLanguage = false;
            if ( $blLoadLanguage = $this->getConfig()->getConfigParam( 'bl_perfLoadLanguages' ) ) {
                $this->_blLoadLanguage = $blLoadLanguage;
            }
        }
        return $this->_blLoadLanguage;
    }

    public function showTopCatNavigation()
    {
        if ( $this->_blShowTopCatNav == null ) {
            $this->_blShowTopCatNav = false;
            if ( $blShowTopCatNav = $this->getConfig()->getConfigParam( 'blTopNaviLayout' ) ) {
                $this->_blShowTopCatNav = $blShowTopCatNav;
            }
        }
        return $this->_blShowTopCatNav;
    }

    public function getTopNavigationCatCnt()
    {
        if ( $this->_iTopCatNavItmCnt == null ) {
            $iTopCatNavItmCnt = $this->getConfig()->getConfigParam( 'iTopNaviCatCount' );
            $this->_iTopCatNavItmCnt = $iTopCatNavItmCnt ? $iTopCatNavItmCnt : 5;
        }
        return $this->_iTopCatNavItmCnt;
    }

    public function getCharSet()
    {
        if ( $this->_sCharSet == null ) {
            $this->_sCharSet = oxLang::getInstance()->translateString( 'charset' );
        }
        return $this->_sCharSet;
    }

    public function getShopVersion()
    {
        if ( $this->_sVersion == null ) {
            $this->_sVersion = $this->getConfig()->getActiveShop()->oxshops__oxversion->value;
        }
        return $this->_sVersion;
    }

    public function getShopEdition()
    {
        return $this->getConfig()->getActiveShop()->oxshops__oxedition->value;
    }

    public function getShopFullEdition()
    {
        $sEdition = $this->getShopEdition();
        $sFullEdition = "Community Edition";
        if ($sEdition == "PE")
            $sFullEdition = "Professional Edition";

        if ($sEdition == "EE")
            $sFullEdition = "Enterprise Edition";

        return $sFullEdition;
    }


    public function isDemoVersion()
    {
        if ( $this->_blDemoVersion == null ) {
            $this->_blDemoVersion = $this->getConfig()->detectVersion() == 1;
        }
        return $this->_blDemoVersion;
    }

    public function isDemoShop()
    {
        if ( $this->_blDemoShop == null ) {
            $this->_blDemoShop = $this->getConfig()->isDemoShop();
        }
        return $this->_blDemoShop;
    }
    
    public function getRssLinks()
    {
        return $this->_aRssLinks;
    }

    public function isSortingActive()
    {
        return $this->_blActiveSorting;
    }

    public function getSortColumns()
    {
        return $this->_aSortColumns;
    }

    public function getListOrderBy()
    {
        return $this->_sListOrderBy;
    }

    public function getListOrderDirection()
    {
        return $this->_sListOrderDir;
    }

    public function getMetaDescription()
    {
        return $this->_sMetaDescription;
    }

    public function getMetaKeywords()
    {
        return $this->_sMetaKeywords;
    }

    public function getActCurrency()
    {
        return $this->_oActCurrency;
    }

    public function setActCurrency( $oCur )
    {
        $this->_oActCurrency = $oCur;
    }

    public function getCompareItemsCnt()
    {
        return $this->_iCompItemsCnt;
    }

    public function setCompareItemsCnt( $iCount )
    {
        $this->_iCompItemsCnt = $iCount;
    }

    public function getWishlistName()
    {
        return $this->_sWishlistName;
    }

    public function setWishlistName( $sName )
    {
        $this->_sWishlistName = $sName;
    }

    public function getMenueList()
    {
        return $this->_aMenueList;
    }

    public function setMenueList( $aMenue )
    {
        $this->_aMenueList = $aMenue;
    }

    public function getEditTags()
    {
    }

    public function getRecommSearch()
    {
        return null;
    }

    public function getReviewUserId()
    {
    }

    public function getPaymentList()
    {
    }

    public function getActiveRecommList()
    {
    }

    public function getAccessoires()
    {
    }

    public function getCrossSelling()
    {
    }

    public function getSimilarProducts()
    {
    }

    public function getAlsoBoughtThiesProducts()
    {
    }

    public function getArticleId()
    {
    }

    public function setActiveCategory( $oCategory )
    {
        $this->_oActCategory = $oCategory;
    }

    public function getActiveCategory()
    {
        return $this->_oActCategory;
    }

    public function isMoreTagsVisible()
    {
        return false;
    }

    public function getTitle()
    {
    }

    public function showNewsletter()
    {
        if ( $this->_iNewsStatus === null) {
            return 1;
        }
        return $this->_iNewsStatus;
    }

    public function setShowNewsletter( $blShow )
    {
        $this->_iNewsStatus = $blShow;
    }

    public function getShopLogo()
    {
        return $this->_sShopLogo;
    }

    public function setShopLogo( $sLogo )
    {
        $this->_sShopLogo = $sLogo;
    }

}

---