oxubase.php

Go to the documentation of this file.

<?php

require_once getShopBasePath() . 'views/oxview.php' ;

// view indexing state for search engines:
define( 'VIEW_INDEXSTATE_INDEX', 0 );           //  index without limitations
define( 'VIEW_INDEXSTATE_NOINDEXNOFOLLOW', 1 ); //  no index / no follow
define( 'VIEW_INDEXSTATE_NOINDEXFOLLOW', 2 );   //  no index / follow

class oxUBase extends oxView
{
    protected $_blFbWidgetsOn = null;

    protected $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&';

    protected $_oaComponents = array();

    protected $_blIsOrderStep = false;

    protected $_sListType = null;

    protected $_aListDisplayTypes = array( 'grid', 'line', 'infogrid' );

    protected $_sListDisplayType = null;

    protected $_oActCategory = null;

    protected $_oActManufacturer = null;

    protected $_oActVendor = null;

    protected $_oActiveRecommList = null;

    protected $_oActSearch = null;

    protected $_blShowSorting = false;

    protected $_blShowRightBasket = null;

    protected $_blShowTopBasket = null;

    protected $_blShowLeftBasket = null;

    protected $_blLoadCurrency = null;

    protected $_blLoadVendorTree = null;

    protected $_blLoadManufacturerTree = null;

    protected $_blDontShowEmptyCats = null;

    protected $_blLoadLanguage = null;

    protected $_blShowTopCatNav = null;

    protected $_iTopCatNavItmCnt = null;

    protected $_aRssLinks = null;

    protected $_sListOrderBy = null;

    protected $_sListOrderDir = null;

    protected $_sMetaDescription = null;

    protected $_sMetaKeywords = null;

    protected $_sMetaDescriptionIdent = null;

    protected $_sMetaKeywordsIdent = null;

    protected $_sAdditionalParams = null;

    protected $_oActCurrency = null;

    protected $_blEnabledPrivateSales = null;

    protected $_blCommonAdded = false;

    protected $_iViewIndexState = VIEW_INDEXSTATE_INDEX;

    protected $_blForceNoIndex = false;

    protected $_sWishlistName = null;

    protected $_iCompItemsCnt = null;

    protected $_sContentId = null;

    protected $_oContent = null;

    protected $_sViewResetID = null;

    protected $_blActiveSorting = null;

    protected $_aMenueList = null;

    protected $_aComponentNames = array(
                                    'oxcmp_user'       => 1, // 0 means dont init if cached
                                    'oxcmp_lang'       => 0,
                                    'oxcmp_cur'        => 1,
                                    'oxcmp_shop'       => 1,
                                    'oxcmp_categories' => 0,
                                    'oxcmp_utils'      => 1,
                                    'oxcmp_news'       => 0,
                                    'oxcmp_basket'     => 1
                                  );

    protected $_aUserComponentNames = array();

    protected $_oProduct = null;

    protected $_iActPage = null;

    protected $_aArticleList = null;

    protected $_oVendorTree  = null;

    protected $_oManufacturerTree  = null;

    protected $_oCategoryTree  = null;

    protected $_aTop5ArticleList  = null;

    protected $_aBargainArticleList  = null;

    protected $_blLowOrderPrice = null;

    protected $_sMinOrderPrice  = null;

    protected $_iNewsRealStatus  = null;

    protected $_aBlockRedirectParams = array( 'fnc', 'stoken', 'force_sid', 'force_admin_sid' );

    protected $_aVendorlist = null;

    protected $_oRootVendor = null;

    protected $_sVendorId = null;

    protected $_aManufacturerlist = null;

    protected $_oRootManufacturer = null;

    protected $_sManufacturerId = null;

    protected $_aSearchCatTree = null;

    protected $_oCatMore = null;

    protected $_blNewsSubscribed = null;

    protected $_oDelAddress = null;

    protected $_sCatTreePath = null;

    protected $_aContents = array();

    protected $_blTop5Action = true;

    protected $_blBargainAction = false;

    protected $_aMustFillFields = null;

    protected $_blShowTagCloud = true;

    protected $_blRootCatChanged = false;

    protected $_aInvoiceAddress = null;

    protected $_aDeliveryAddress = null;

    protected $_sActiveUsername = null;

    protected static $_aCollectedComponentNames = null;

    protected function _getComponentNames()
    {
        if ( self::$_aCollectedComponentNames === null ) {
            self::$_aCollectedComponentNames = array_merge( $this->_aComponentNames, $this->_aUserComponentNames );

            // #1721: custom component handling. At the moment it is not possible to override this variable in oxubase,
            // so we added this array to config.inc.php file
            if ( ( $aUserCmps = $this->getConfig()->getConfigParam( 'aUserComponentNames' ) ) ) {
                self::$_aCollectedComponentNames = array_merge( self::$_aCollectedComponentNames, $aUserCmps );
            }

            if ( oxConfig::getParameter( '_force_no_basket_cmp' ) ) {
                unset( self::$_aCollectedComponentNames['oxcmp_basket'] );
            }
        }

        // resetting array pointer
        reset( self::$_aCollectedComponentNames );
        return self::$_aCollectedComponentNames;
    }

    protected function _processRequest()
    {
        $myUtils = oxUtils::getInstance();

        // non admin, request is not empty and was not processed by seo engine
        if ( !isSearchEngineUrl() && $myUtils->seoIsActive() && ( $sStdUrl = getRequestUrl( '', true ) ) ) {

            // fetching standard url and looking for it in seo table
            if ( $this->_canRedirect() && ( $sRedirectUrl = oxSeoEncoder::getInstance()->fetchSeoUrl( $sStdUrl ) ) ) {
                $myUtils->redirect( $this->getConfig()->getCurrentShopUrl() . $sRedirectUrl, false );
            } elseif (VIEW_INDEXSTATE_INDEX == $this->noIndex()) {
                // forcing to set noindex/follow meta
                $this->_forceNoIndex();

                if (!$this->getConfig()->isProductiveMode() || $this->getConfig()->getConfigParam('blSeoLogging')) {
                    $sShopId = $this->getConfig()->getShopId();
                    $sLangId = oxLang::getInstance()->getBaseLanguage();
                    $sIdent  = md5( strtolower( $sStdUrl ) . $sShopId . $sLangId );

                    // logging "not found" url
                    $oDb = oxDb::getDb();
                    $oDb->execute( "replace oxseologs ( oxstdurl, oxident, oxshopid, oxlang )
                                    values ( " . $oDb->quote( $sStdUrl ) . ", '{$sIdent}', '{$sShopId}', '{$sLangId}' ) " );
                }
            }
        }
    }

    public function init()
    {
        $this->_processRequest();

        // storing current view
        $blInit = true;


        // init all components if there are any
        foreach ( $this->_getComponentNames() 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() );
                }
            }
        }

        parent::init();

        // enable sorting ?
        if ( $this->showSorting() ) {
            $this->prepareSortColumns();
        }
    }

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

        $myConfig = $this->getConfig();
        $iLang = oxLang::getInstance()->getBaseLanguage();
        $iCur  = (int) $myConfig->getShopCurrency();


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

        $this->_sViewId .= "|".( (int) $this->_blForceNoIndex ).'|'.((int)$this->isRootCatChanged());

        // #0002866: external global viewID addition
        if (function_exists('customGetViewId')) {
            $oExtViewId = customGetViewId();

            if ($oExtViewId !== null) {
                $this->_sViewId .= '|'.md5(serialize($oExtViewId));
            }
        }

        return $this->_sViewId;
    }


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

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

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

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

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


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

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

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

    public function getListDisplayType()
    {
        if ( $this->_sListDisplayType == null ) {
            $this->_sListDisplayType = oxConfig::getParameter( 'ldtype' );

            if ( !$this->_sListDisplayType ) {
                $this->_sListDisplayType = oxSession::getVar( 'ldtype' );
            }

            if ( !$this->_sListDisplayType ) {
                $this->_sListDisplayType = $this->getConfig()->getConfigParam( 'sDefaultListDisplayType' );
            }

            $this->_sListDisplayType = in_array( ( string ) $this->_sListDisplayType, $this->_aListDisplayTypes ) ? $this->_sListDisplayType : 'infogrid';

            // writing to session
            if ( oxConfig::getParameter( 'ldtype' ) ) {
                oxSession::setVar( 'ldtype', $this->_sListDisplayType );
            }
        }
        return $this->_sListDisplayType;
    }

    public function setListType( $sType )
    {
        $this->_sListType = $sType;
        $this->getConfig()->setGlobalParameter( 'listtype', $sType );
    }

    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 loadManufacturerTree()
    {
        if ( $this->_blLoadManufacturerTree == null ) {
            $this->_blLoadManufacturerTree = false;
            if ( $blLoadManufacturerTree = $this->getConfig()->getConfigParam( 'bl_perfLoadManufacturerTree' ) ) {
                $this->_blLoadManufacturerTree = $blLoadManufacturerTree;
            }
        }
        return $this->_blLoadManufacturerTree;
    }

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

    public function showCategoryArticlesCount()
    {
        return $this->getConfig()->getConfigParam( 'bl_perfShowActionCatArticleCnt' );
    }

    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 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);
        }
    }

    public function getSortOrderByParameterName()
    {
        return 'listorderby';
    }

    public function getSortOrderParameterName()
    {
        return 'listorder';
    }

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

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

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


            $sSortBy  = oxConfig::getParameter( $this->getSortOrderByParameterName() );
            $sSortDir = oxConfig::getParameter( $this->getSortOrderParameterName() );

            $oStr = getStr();
            if ( (!$sSortBy || !in_array( $oStr->strtolower($sSortBy), $aSortColumns) || !in_array( $oStr->strtolower($sSortDir), $aSortDir) ) && $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 );
            }
        }
    }

    public function getListOrderBy()
    {
        //if column is with table name split it
        $aColums = explode('.', $this->_sListOrderBy);

        if ( is_array($aColums) && count($aColums) > 1 ) {
           return $aColums[1];
        }

        return $this->_sListOrderBy;
    }

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

    public function setMetaDescription ( $sDescription )
    {
        return $this->_sMetaDescription = $sDescription;
    }

    public function setMetaKeywords( $sKeywords )
    {
        return $this->_sMetaKeywords = $sKeywords;
    }

    protected function _getMetaFromSeo( $sDataType )
    {
        $sOxid  = $this->_getSeoObjectId();
        $iLang  = oxLang::getInstance()->getBaseLanguage();
        $sShop  = $this->getConfig()->getShopId();

        if ( $sOxid && oxUtils::getInstance()->seoIsActive() &&
             ( $sKeywords = oxSeoEncoder::getInstance()->getMetaData( $sOxid, $sDataType, $sShop, $iLang) ) ) {
            return $sKeywords;
        }
    }

    protected function _getMetaFromContent( $sMetaIdent )
    {
        if ( $sMetaIdent ) {
            $oContent = oxNew( 'oxcontent' );
            if ( $oContent->loadByIdent( $sMetaIdent ) &&
                 $oContent->oxcontents__oxactive->value ) {
                return strip_tags( $oContent->oxcontents__oxcontent->value );
            }
        }
    }

    public function getMetaKeywords()
    {
        if ( $this->_sMetaKeywords === null ) {
            $this->_sMetaKeywords = false;

            // set special meta keywords ?
            if ( ( $sKeywords = $this->_getMetaFromSeo( 'oxkeywords' ) ) ) {
                $this->_sMetaKeywords = $sKeywords;
            } elseif ( ( $sKeywords = $this->_getMetaFromContent( $this->_sMetaKeywordsIdent ) ) ) {
                $this->_sMetaKeywords = $this->_prepareMetaKeyword( $sKeywords, false );
            } else {
                $this->_sMetaKeywords = $this->_prepareMetaKeyword( false, true );
            }
        }

        return $this->_sMetaKeywords;
    }

    public function getMetaDescription()
    {
        if ( $this->_sMetaDescription === null ) {
            $this->_sMetaDescription = false;

            // set special meta description ?
            if ( ( $sDescription = $this->_getMetaFromSeo( 'oxdescription' ) ) ) {
                $this->_sMetaDescription = $sDescription;
            } elseif ( ( $sDescription = $this->_getMetaFromContent( $this->_sMetaDescriptionIdent ) ) ) {
                $this->_sMetaDescription = $this->_prepareMetaDescription( $sDescription );
            } else {
                $this->_sMetaDescription = $this->_prepareMetaDescription( false );
            }
        }

        return $this->_sMetaDescription;
    }

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

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

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

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

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

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

    protected function _forceNoIndex()
    {
        $this->_blForceNoIndex = true;
    }

    public function noIndex()
    {
        if ( $this->_blForceNoIndex ) {
            $this->_iViewIndexState = VIEW_INDEXSTATE_NOINDEXFOLLOW;
        } elseif ( oxConfig::getParameter( 'cur' ) ) {
            $this->_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW;
        } else {
            switch ( oxConfig::getParameter( 'fnc' ) ) {
                case 'tocomparelist':
                case 'tobasket':
                    $this->_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW;
                    break;
            }
        }
        return $this->_iViewIndexState;
    }

    public function getContentId()
    {
        if ( $this->_sContentId === null) {
            $oContent = oxNew( 'oxcontent' );
            $oContent->loadByIdent( 'oximpressum' );
            $this->_sContentId = $oContent->getId();
        }

        return $this->_sContentId;
    }

    public function getContent()
    {
        if ( $this->_oContent === null) {
            $oContent = oxNew( 'oxcontent' );
            if ( $oContent->load( $this->getContentId() ) && $oContent->oxcontents__oxactive->value ) {
                $this->_oContent = $oContent;
            }
        }

        return $this->_oContent;
    }

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

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

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


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

        //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
        switch ( $this->getListDisplayType() ) {
            case 'grid':
                $aNrofCatArticles = $myConfig->getConfigParam( 'aNrofCatArticlesInGrid' );
                break;
            case 'line':
            case 'infogrid':
            default:
                $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 ( ( $iNrofArticles = (int) oxConfig::getParameter( '_artperpage' ) ) ) {
            // 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 );
    }

    protected function _getSeoObjectId()
    {
    }

    protected function _prepareMetaDescription( $sMeta, $iLength = 1024, $blRemoveDuplicatedWords = false )
    {
        if ( $sMeta ) {

            $oStr = getStr();
            if ( $iLength != -1 ) {
                /* *
                 * performance - we dont need a huge amount of initial text.
                 * assume that effective text may be double longer than $iLength
                 * and simple turncate it
                 */
                $iELength = ( $iLength * 2 );
                $sMeta = $oStr->substr( $sMeta, 0, $iELength );
            }

            // decoding html entities
            $sMeta = $oStr->html_entity_decode( $sMeta );
            // stripping HTML tags
            $sMeta = strip_tags( $sMeta );

            // removing some special chars
            $sMeta = $oStr->cleanStr( $sMeta );

            // removing duplicate words
            if ( $blRemoveDuplicatedWords ) {
                $sMeta = $this->_removeDuplicatedWords( $sMeta, $this->getConfig()->getConfigParam( 'aSkipTags' ) );
            }

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

            return trim( $sMeta );
        }
    }

    protected function _prepareMetaKeyword( $sKeywords, $blRemoveDuplicatedWords = true )
    {

        $sString = $this->_prepareMetaDescription( $sKeywords, -1, false );

        if ( $blRemoveDuplicatedWords ) {
            $sString = $this->_removeDuplicatedWords( $sString, $this->getConfig()->getConfigParam( 'aSkipTags' ) );
        }

        // removing in admin defined strings

        /*if ( is_array( $aSkipTags ) && $sString ) {
            $oStr = getStr();
            foreach ( $aSkipTags as $sSkip ) {
                //$aPattern = array( '/\W'.$sSkip.'\W/iu', '/^'.$sSkip.'\W/iu', '/\"'.$sSkip.'$/iu' );
                //$aPattern = array( '/\s+'.$sSkip.'\,/iu', '/^'.$sSkip.'\s+/iu', '/\"\s+'.$sSkip.'$/iu' );
                $aPattern = array( '/\s+'.$sSkip.'\,/i', '/^'.$sSkip.',\s+/i', '/\",\s+'.$sSkip.'$/i' );
                $sString  = $oStr->preg_replace( $aPattern, '', $sString );
            }
        }*/

        return trim( $sString );
    }

    protected function _removeDuplicatedWords( $aInput, $aSkipTags = array() )
    {
        $oStr = getStr();
        if ( is_array( $aInput ) ) {
            $aInput = implode( " ", $aInput );
        }

        // removing some usually met characters..
        $aInput = $oStr->preg_replace( "/[".preg_quote( $this->_sRemoveMetaChars, "/" )."]/", " ", $aInput );

        // splitting by word
        $aStrings = $oStr->preg_split( "/[\s,]+/", $aInput );

        if ( $sCount = count( $aSkipTags ) ) {
            for ( $iNum = 0; $iNum < $sCount; $iNum++ ) {
                $aSkipTags[$iNum] = $oStr->strtolower( $aSkipTags[$iNum] );
            }
        }
        $sCount = count($aStrings);
        for ( $iNum = 0; $iNum < $sCount; $iNum++ ) {
            $aStrings[$iNum] = $oStr->strtolower( $aStrings[$iNum] );
            // removing in admin defined strings
            if ( !$aStrings[$iNum] || in_array( $aStrings[$iNum], $aSkipTags ) ) {
                unset( $aStrings[$iNum] );
            }
        }

        // duplicates
        return implode( ', ', array_unique( $aStrings ) );
    }

    public function getNavigationParams()
    {
        $aParams['cnid'] = $this->getCategoryId();
        $aParams['mnid'] = oxConfig::getParameter( 'mnid' );

        $aParams['listtype'] = $this->getListType();
        $aParams['ldtype'] = $this->getListDisplayType();

        $aParams['recommid'] = oxConfig::getParameter( 'recommid' );

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

        $aParams['searchvendor'] = oxConfig::getParameter( 'searchvendor' );
        $aParams['searchcnid']   = oxConfig::getParameter( 'searchcnid' );
        $aParams['searchmanufacturer'] = oxConfig::getParameter( 'searchmanufacturer' );

        return $aParams;
    }

    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 getTitleSuffix()
    {
        return $this->getConfig()->getActiveShop()->oxshops__oxtitlesuffix->value;
    }

    public function getTitlePageSuffix()
    {
    }

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



    protected function _getSubject( $iLang )
    {
        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', true ) ) ) {
                    $sRet .= '&amp;searchcnid='.rawurlencode( rawurldecode( $sVar ) );
                }
                if ( ( $sVar = oxConfig::getParameter( 'searchvendor', true ) ) ) {
                    $sRet .= '&amp;searchvendor='.rawurlencode( rawurldecode( $sVar ) );
                }
                if ( ( $sVar = oxConfig::getParameter( 'searchmanufacturer', true ) ) ) {
                    $sRet .= '&amp;searchmanufacturer='.rawurlencode( rawurldecode( $sVar ) );
                }
                break;
            case 'tag':
                $sRet .= "&amp;listtype={$sListType}";
                if ( $sParam = rawurlencode( oxConfig::getParameter( 'searchtag', true ) ) ) {
                    $sRet .= "&amp;searchtag={$sParam}";
                }
                break;
        }

        return $sRet;
    }

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

        $oDisplayObj = null;
        $blTrySeo = false;
        if ( oxUtils::getInstance()->seoIsActive() ) {
            $blTrySeo = true;
            $oDisplayObj = $this->_getSubject( $iLang );
        }
        $iActPageNr = $this->getActPage();

        if ( $oDisplayObj ) {
            return $this->_addPageNrParam( $oDisplayObj->getLink( $iLang ), $iActPageNr, $iLang );
        }

        $myConfig = $this->getConfig();

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

        $sUrl = oxUtilsUrl::getInstance()->processUrl( $myConfig->getShopCurrentURL( $iLang ) . $this->_getRequestParams(), true, null, $iLang);

        // fallback to old non seo url
        return $this->_addPageNrParam( $sUrl, $iActPageNr, $iLang );
    }

    public function getCanonicalUrl()
    {
    }

    public function getSimilarRecommLists()
    {
    }

    public function getSearchParamForHtml()
    {
    }

    protected function _getRequestParams( $blAddPageNr  = true )
    {
        $sClass = $this->getClassName();
        $sFnc   = $this->getFncName();

        $aFnc = array( 'tobasket', 'login_noredirect', 'addVoucher', 'moveleft', 'moveright' );
        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( 'mnid' ) ) {
            $sURL .= "&amp;mnid={$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( 'searchmanufacturer' ) ) {
            $sURL .= "&amp;searchmanufacturer={$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 showSearch()
    {
        $blShow = true;
        if ( $this->getConfig()->getConfigParam( 'blDisableNavBars' ) && $this->getIsOrderStep() ) {
            $blShow = false;
        }
        return (int) $blShow;
    }

    public function getRssLinks()
    {
        return $this->_aRssLinks;
    }

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

    public function getEditTags()
    {
    }

    public function getRecommSearch()
    {
    }

    public function getPaymentList()
    {
    }

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

    public function getAccessoires()
    {
    }

    public function getCrossSelling()
    {
    }

    public function getSimilarProducts()
    {
    }

    public function getAlsoBoughtTheseProducts()
    {
    }

    public function getArticleId()
    {
    }

    public function isMoreTagsVisible()
    {
        return false;
    }

    public function getTitle()
    {
    }

    public function getActiveLangAbbr()
    {
        // Performance
        if ( !$this->getConfig()->getConfigParam( 'bl_perfLoadLanguages' ) ) {
            return;
        }

        if ( !isset($this->_sActiveLangAbbr ) ) {
            $aLanguages = oxLang::getInstance()->getLanguageArray();
            while ( list( $sKey, $oVal ) = each( $aLanguages ) ) {
                if ( $oVal->selected ) {
                    $this->_sActiveLangAbbr = $oVal->abbr;
                    break;
                }
            }
        }

        return $this->_sActiveLangAbbr;
    }

    public function addGlobalParams( $oShop = null)
    {
        $oViewConf = parent::addGlobalParams( $oShop );

        $this->_setNrOfArtPerPage();

        return $oViewConf;
    }

    public function getAdditionalParams()
    {
        if ( $this->_sAdditionalParams === null ) {
            // #1018A
            $this->_sAdditionalParams  = parent::getAdditionalParams();
            $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( 'searchtag' ) ) ) {
                $this->_sAdditionalParams .= '&amp;searchtag='.rawurlencode( rawurldecode( $sVar ) );
            }
            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( 'searchmanufacturer' ) ) ) {
                $this->_sAdditionalParams .= '&amp;searchmanufacturer='.rawurlencode( rawurldecode( $sVar ) );
            }
            if ( ( $sVar = oxConfig::getParameter( 'cnid' ) ) ) {
                $this->_sAdditionalParams .= '&amp;cnid='.rawurlencode( rawurldecode( $sVar ) );
            }
            if ( ( $sVar = oxConfig::getParameter( 'mnid' ) ) ) {
                $this->_sAdditionalParams .= '&amp;mnid='.rawurlencode( rawurldecode( $sVar ) );
            }
        }

        return $this->_sAdditionalParams;
    }

    public function generatePageNavigationUrl()
    {
        return $this->getConfig()->getShopHomeURL().$this->_getRequestParams( false );
    }

    protected function _addPageNrParam( $sUrl, $iPage, $iLang = null )
    {
        if ( $iPage ) {
            if ( ( strpos( $sUrl, 'pgNr=' ) ) ) {
                $sUrl = preg_replace('/pgNr=[0-9]*/', 'pgNr='.$iPage, $sUrl);
            } else {
                $sUrl .= ( ( strpos( $sUrl, '?' ) === false ) ? '?' : '&amp;' ) . 'pgNr='.$iPage;
            }
        } else {
           $sUrl = preg_replace('/pgNr=[0-9]*/', '', $sUrl);
           $sUrl = preg_replace('/\&amp\;\&amp\;/', '&amp;', $sUrl);
           $sUrl = preg_replace('/\?\&amp\;/', '?', $sUrl);
           $sUrl = preg_replace('/\&amp\;$/', '', $sUrl);
        }
        return $sUrl;
    }

    public function getPageNavigation()
    {

    }

    public function getPageNavigationLimitedTop()
    {

        $this->_oPageNavigation = $this->generatePageNavigation( 7 );

        return $this->_oPageNavigation;
    }

    public function getPageNavigationLimitedBottom()
    {

        $this->_oPageNavigation = $this->generatePageNavigation( 11 );

        return $this->_oPageNavigation;
    }


    public function generatePageNavigation( $iPositionCount = 0 )
    {
        startProfile('generatePageNavigation');

        $pageNavigation = new stdClass();

        $pageNavigation->NrOfPages = $this->_iCntPages;
        $iActPage = $this->getActPage();
        $pageNavigation->actPage   = $iActPage + 1;
        $sUrl = $this->generatePageNavigationUrl();

        if ( $iPositionCount == 0 || ($iPositionCount >= $pageNavigation->NrOfPages) ) {
             $iStartNo = 2;
             $iFinishNo = $pageNavigation->NrOfPages;
             $bStart = false;
             $bFinish =false;
        } else {
            $iTmpVal = $iPositionCount - 3;
            $iTmpVal2 = floor( ( $iPositionCount - 4 ) / 2 );

            // actual page is at the start
            if ( $pageNavigation->actPage <= $iTmpVal ) {
                $iStartNo = 2;
                $iFinishNo = $iTmpVal + 1;
                $bStart = false;
                $bFinish = true;
            // actual page is at the end
            } elseif ( $pageNavigation->actPage >= $pageNavigation->NrOfPages - $iTmpVal ) {
                $iStartNo = $pageNavigation->NrOfPages - $iTmpVal;
                $iFinishNo = $pageNavigation->NrOfPages - 1;
                $bStart = true;
                $bFinish = false;
            // actual page is in the midle
            } else {
                $iStartNo = $pageNavigation->actPage - $iTmpVal2;
                $iFinishNo = $pageNavigation->actPage + $iTmpVal2;
                $bStart = true;
                $bFinish = true;
            }
        }

        if ( $iActPage > 0) {
            $pageNavigation->previousPage = $this->_addPageNrParam( $sUrl, $iActPage - 1 );
        }

        if ( $iActPage < $pageNavigation->NrOfPages - 1 ) {
            $pageNavigation->nextPage = $this->_addPageNrParam( $sUrl, $iActPage + 1 );
        }

        if ( $pageNavigation->NrOfPages > 1 ) {

            for ( $i=1; $i < $pageNavigation->NrOfPages + 1; $i++ ) {

                if ( $i == 1 || $i == $pageNavigation->NrOfPages || ( $i >= $iStartNo && $i <= $iFinishNo ) ) {
                    $page = new Oxstdclass();
                    $page->url = $this->_addPageNrParam( $sUrl, $i - 1 );
                    $page->selected = ( $i == $pageNavigation->actPage ) ? 1 : 0;
                    $pageNavigation->changePage[$i] = $page;
                }
            }

            // first/last one
            $pageNavigation->firstpage = $this->_addPageNrParam( $sUrl, 0 );
            $pageNavigation->lastpage  = $this->_addPageNrParam( $sUrl, $pageNavigation->NrOfPages - 1 );
        }

        stopProfile('generatePageNavigation');

        return $pageNavigation;
    }

    public function getArticleCount()
    {
        return $this->_iAllArtCnt;
    }

    public function render()
    {
        foreach ( array_keys( $this->_oaComponents ) as $sComponentName ) {
            $this->_aViewData[$sComponentName] = $this->_oaComponents[$sComponentName]->render();
        }

        parent::render();

        if ( $this->getIsOrderStep() ) {

            // disabling navigation during order ...
            if ( $this->getConfig()->getConfigParam( 'blDisableNavBars' ) ) {
                $this->_iNewsRealStatus = 1;
                $this->setShowNewsletter( 0 );
                $this->setShowRightBasket( 0 );
                $this->setShowLeftBasket( 0 );
                $this->setShowTopBasket( 0 );
            }
        }
        return $this->_sThisTemplate;
    }

    public function getViewProduct()
    {
        return $this->getProduct();
    }

    public function setViewProduct( $oProduct )
    {
        $this->_oProduct = $oProduct;
    }

    public function getViewProductList()
    {
        return $this->_aArticleList;
    }

    public function getActPage()
    {
        if ( $this->_iActPage === null ) {
            $this->_iActPage = ( int ) oxConfig::getParameter( 'pgNr' );
            $this->_iActPage = ( $this->_iActPage < 0 ) ? 0 : $this->_iActPage;
        }
        return $this->_iActPage;
    }

    public function getActTag()
    {
        if ( $this->_oActTag === null ) {
            $this->_oActTag = new Oxstdclass();
            $this->_oActTag->sTag = $sTag = oxConfig::getParameter("searchtag", 1);
            $oSeoEncoderTag = oxSeoEncoderTag::getInstance();

            $sLink = false;
            if ( oxUtils::getInstance()->seoIsActive() ) {
                $sLink = $oSeoEncoderTag->getTagUrl( $sTag, oxLang::getInstance()->getBaseLanguage() );
            }

            $this->_oActTag->link = $sLink ? $sLink : $this->getConfig()->getShopHomeURL().$oSeoEncoderTag->getStdTagUri( $sTag, false );
        }
        return $this->_oActTag;
    }

    public function getActVendor()
    {
        // if active vendor is not set yet - trying to load it from request params
        // this may be usefull when category component was unable to load active vendor
        // and we still need some object to mount navigation info
        if ( $this->_oActVendor === null ) {
            $this->_oActVendor = false;
            $sVendorId = oxConfig::getParameter( 'cnid' );
            $sVendorId = $sVendorId ? str_replace( 'v_', '', $sVendorId ) : $sVendorId;
            $oVendor = oxNew( 'oxvendor' );
            if ( $oVendor->load( $sVendorId ) ) {
                $this->_oActVendor = $oVendor;
            }
        }

        return $this->_oActVendor;
    }

    public function getActManufacturer()
    {
        // if active Manufacturer is not set yet - trying to load it from request params
        // this may be usefull when category component was unable to load active Manufacturer
        // and we still need some object to mount navigation info
        if ( $this->_oActManufacturer === null ) {

            $this->_oActManufacturer = false;
            $sManufacturerId = oxConfig::getParameter( 'mnid' );
            $oManufacturer = oxNew( 'oxmanufacturer' );
            if ( $oManufacturer->load( $sManufacturerId ) ) {
                $this->_oActManufacturer = $oManufacturer;
            }
        }

        return $this->_oActManufacturer;
    }

    public function setActVendor( $oVendor )
    {
        $this->_oActVendor = $oVendor;
    }

    public function setActManufacturer( $oManufacturer )
    {
        $this->_oActManufacturer = $oManufacturer;
    }

    public function getActSearch()
    {
        if ( $this->_oActSearch === null ) {
            $this->_oActSearch = new oxStdClass();
            $sUrl = $this->getConfig()->getShopHomeURL();
            $this->_oActSearch->link = "{$sUrl}cl=search";
        }
        return $this->_oActSearch;
    }

    public function getCategoryTree()
    {
        return $this->_oCategoryTree;
    }

    public function setCategoryTree( $oCatTree )
    {
        $this->_oCategoryTree = $oCatTree;
    }

    public function getVendorTree()
    {
        return $this->_oVendorTree;
    }

    public function setVendorTree( $oVendorTree )
    {
        $this->_oVendorTree = $oVendorTree;
    }

    public function getManufacturerTree()
    {
        return $this->_oManufacturerTree;
    }

    public function setManufacturerTree( $oManufacturerTree )
    {
        $this->_oManufacturerTree = $oManufacturerTree;
    }

    public function getAddUrlParams()
    {
    }

    public function getTop5ArticleList()
    {
        if ( $this->_blTop5Action ) {
            if ( $this->_aTop5ArticleList === null ) {
                $this->_aTop5ArticleList = false;
                $myConfig = $this->getConfig();
                if ( $myConfig->getConfigParam( 'bl_perfLoadAktion' ) ) {
                    // top 5 articles
                    $oArtList = oxNew( 'oxarticlelist' );
                    $oArtList->loadTop5Articles();
                    if ( $oArtList->count() ) {
                        $this->_aTop5ArticleList = $oArtList;
                    }
                }
            }
        }
        return $this->_aTop5ArticleList;
    }

    public function getBargainArticleList()
    {
        if ( $this->_blBargainAction ) {
            if ( $this->_aBargainArticleList === null ) {
                $this->_aBargainArticleList = array();
                if ( $this->getConfig()->getConfigParam( 'bl_perfLoadAktion' ) ) {
                    $oArtList = oxNew( 'oxarticlelist' );
                    $oArtList->loadAktionArticles( 'OXBARGAIN' );
                    if ( $oArtList->count() ) {
                        $this->_aBargainArticleList = $oArtList;
                    }
                }
            }
        }
        return $this->_aBargainArticleList;
    }

    public function isLowOrderPrice()
    {
        if ( $this->_blLowOrderPrice === null && ( $oBasket = $this->getSession()->getBasket() ) ) {
            $this->_blLowOrderPrice = $oBasket->isBelowMinOrderPrice();
        }

        return $this->_blLowOrderPrice;
    }

    public function getMinOrderPrice()
    {
        if ( $this->_sMinOrderPrice === null && $this->isLowOrderPrice() ) {
            $dMinOrderPrice = oxPrice::getPriceInActCurrency( $this->getConfig()->getConfigParam( 'iMinOrderPrice' ) );
            $this->_sMinOrderPrice = oxLang::getInstance()->formatCurrency( $dMinOrderPrice );
        }
        return $this->_sMinOrderPrice;
    }

    public function getNewsRealStatus()
    {
        return $this->_iNewsRealStatus;
    }

    protected function _canRedirect()
    {
        foreach ( $this->_aBlockRedirectParams as $sParam ) {
            if ( oxConfig::getParameter( $sParam ) !== null ) {
                return false;
            }
        }

        return true;
    }

    public function getProduct()
    {
    }

    public function getVendorlist()
    {
        return $this->_aVendorlist;
    }

    public function setVendorlist( $aList )
    {
        $this->_aVendorlist = $aList;
    }

    public function getManufacturerlist()
    {
        return $this->_aManufacturerlist;
    }

    public function setManufacturerlist( $aList )
    {
        $this->_aManufacturerlist = $aList;
    }

    public function setRootVendor( $oVendor )
    {
        $this->_oRootVendor = $oVendor;
    }

    public function getRootVendor()
    {
        return $this->_oRootVendor;
    }

    public function setRootManufacturer( $oManufacturer )
    {
        $this->_oRootManufacturer = $oManufacturer;
    }

    public function getRootManufacturer()
    {
        return $this->_oRootManufacturer;
    }

    public function getVendorId()
    {
        if ( $this->_sVendorId === null ) {
            $this->_sVendorId = false;
            if ( ( $oVendor = $this->getActVendor() ) ) {
                $this->_sVendorId = $oVendor->getId();
            }
        }
        return $this->_sVendorId;
    }

    public function getManufacturerId()
    {
        if ( $this->_sManufacturerId === null ) {
            $this->_sManufacturerId = false;
            if ( ( $oManufacturer = $this->getActManufacturer() ) ) {
                $this->_sManufacturerId = $oManufacturer->getId();
            }
        }
        return $this->_sManufacturerId;
    }

    public function getSearchCatTree()
    {
        return $this->_aSearchCatTree;
    }

    public function setSearchCatTree( $aTree )
    {
        $this->_aSearchCatTree = $aTree;
    }

    public function getCatMoreUrl()
    {
        return $this->getConfig()->getShopHomeURL().'cnid=oxmore';
    }

    public function getCatMore()
    {
        return $this->_oCatMore;
    }

    public function setCatMore( $oCat )
    {
        $this->_oCatMore = $oCat;
    }

    public function getCatTreePath()
    {
        return $this->_sCatTreePath;
    }

    public function getContentByIdent( $sIdent )
    {
        if ( !isset( $this->_aContents[$sIdent] ) ) {
            $this->_aContents[$sIdent] = oxNew( 'oxcontent' );
            $this->_aContents[$sIdent]->loadByIdent( $sIdent );
        }
        return $this->_aContents[$sIdent];
    }

    public function getContentCategory()
    {
        return false;
    }

    public function getMustFillFields()
    {
        if ( $this->_aMustFillFields === null ) {
            $this->_aMustFillFields = false;

            // passing must-be-filled-fields info
            $aMustFillFields = $this->getConfig()->getConfigParam( 'aMustFillFields' );
            if ( is_array( $aMustFillFields ) ) {
                $this->_aMustFillFields = array_flip( $aMustFillFields );
            }
        }
        return $this->_aMustFillFields;
    }

    public function isFieldRequired( $sField )
    {
        if ( $aMustFillFields = $this->getMustFillFields() ) {
            if ( isset( $aMustFillFields[$sField] ) ) {
                return true;
            }
        }

        return false;
    }

    public function getFormId()
    {
        if ( $this->_sFormId === null ) {
            $this->_sFormId = oxUtilsObject::getInstance()->generateUId();
            oxSession::setVar( 'sessionuformid', $this->_sFormId );
        }

        return $this->_sFormId;
    }

    public function canAcceptFormData()
    {
        if ( $this->_blCanAcceptFormData === null ) {
            $this->_blCanAcceptFormData = false;

            $sFormId = oxConfig::getParameter( "uformid" );
            $sSessionFormId = oxSession::getVar( "sessionuformid" );

            // testing if form and session ids matches
            if ( $sFormId && $sFormId === $sSessionFormId ) {
                $this->_blCanAcceptFormData = true;
            }

            // regenerating form data
            $this->getFormId();
        }
        return $this->_blCanAcceptFormData;
    }

    public function getPromoFinishedList()
    {
        if (isset($this->_oPromoFinishedList)) {
            return $this->_oPromoFinishedList;
        }
        $this->_oPromoFinishedList = oxNew( 'oxActionList' );
        $this->_oPromoFinishedList->loadFinishedByCount(2);
        return $this->_oPromoFinishedList;
    }

    public function getPromoCurrentList()
    {
        if (isset($this->_oPromoCurrentList)) {
            return $this->_oPromoCurrentList;
        }
        $this->_oPromoCurrentList = oxNew( 'oxActionList' );
        $this->_oPromoCurrentList->loadCurrent();
        return $this->_oPromoCurrentList;
    }

    public function getPromoFutureList()
    {
        if (isset($this->_oPromoFutureList)) {
            return $this->_oPromoFutureList;
        }
        $this->_oPromoFutureList = oxNew( 'oxActionList' );
        $this->_oPromoFutureList->loadFutureByCount(2);
        return $this->_oPromoFutureList;
    }

    public function getShowPromotionList()
    {
        if (isset($this->_blShowPromotions)) {
            return $this->_blShowPromotions;
        }
        $this->_blShowPromotions = false;
        if (oxNew('oxActionList')->areAnyActivePromotions()) {
            $this->_blShowPromotions = ( count( $this->getPromoFinishedList() ) + count( $this->getPromoCurrentList() ) + count( $this->getPromoFutureList() ) ) > 0;
        }
        return $this->_blShowPromotions;
    }

    public function isEnabledPrivateSales()
    {
        if ( $this->_blEnabledPrivateSales === null ) {
            $this->_blEnabledPrivateSales = (bool) $this->getConfig()->getConfigParam( 'blPsLoginEnabled' );
            if ( $this->_blEnabledPrivateSales && ( $blCanPreview = oxUtils::getInstance()->canPreview() ) !== null ) {
                $this->_blEnabledPrivateSales = !$blCanPreview;
            }
        }
        return $this->_blEnabledPrivateSales;
    }

    public function getTagCloudManager()
    {
        if ( $this->_blShowTagCloud ) {
            return oxNew( "oxTagCloud" );
        } else {
            return false;
        }
    }

    public function getFieldValidationErrors()
    {
        return oxInputValidator::getInstance()->getFieldValidationErrors();
    }

    public function getBreadCrumb()
    {
        return null;
    }

    public function setRootCatChanged( $blRootCatChanged )
    {
        $this->_blRootCatChanged = $blRootCatChanged;
    }

    public function isRootCatChanged()
    {
        return $this->_blRootCatChanged;
    }

    public function getInvoiceAddress()
    {
        if ( $this->_aInvoiceAddress == null ) {
            $aAddress = oxConfig::getParameter( 'invadr');
            if ( $aAddress ) {
                $this->_aInvoiceAddress = $aAddress;
            }
        }
        return $this->_aInvoiceAddress;
    }

    public function getDeliveryAddress()
    {
        if ( $this->_aDeliveryAddress == null ) {
            $aAddress = oxConfig::getParameter( 'deladr');
            //do not show deladr if address was reloaded
            if ( $aAddress && !oxConfig::getParameter( 'reloadaddress' )) {
                $this->_aDeliveryAddress = $aAddress;
            }
        }
        return $this->_aDeliveryAddress;
    }

    public function setInvoiceAddress( $aAddress )
    {
        $this->_aInvoiceAddress = $aAddress;
    }

    public function getActiveUsername()
    {
        if ( $this->_sActiveUsername == null ) {
            $this->_sActiveUsername = false;
            $sUsername = oxConfig::getParameter( 'lgn_usr' );
            if ( $sUsername ) {
                $this->_sActiveUsername = $sUsername;
            } elseif ( $oUser = $this->getUser() ) {
                $this->_sActiveUsername = $oUser->oxuser__oxusername->value;
            }
        }
        return $this->_sActiveUsername;
    }

    public function getWishlistUserId()
    {
        return oxConfig::getParameter( 'wishid' );
    }

    public function getSearchCatId()
    {
    }

    public function getSearchVendor()
    {
    }

    public function getSearchManufacturer()
    {
    }

    public function getLastProducts()
    {

    }

    public function getNewBasketItemMsgType()
    {
        return (int) $this->getConfig()->getConfigParam( "iNewBasketItemMessage" );
    }

    public function showTags()
    {
        return (bool) $this->getConfig()->getConfigParam( "blShowTags" );
    }

    public function isActive( $sName )
    {
        return $this->getConfig()->getConfigParam( "bl".$sName."Enabled" );
    }

    public function isFbWidgetVisible()
    {
        if ( $this->_blFbWidgetsOn === null ) {
            $oUtils = oxUtilsServer::getInstance();

            // reading ..
            $this->_blFbWidgetsOn = (bool) $oUtils->getOxCookie( "fbwidgetson" );
        }
        return $this->_blFbWidgetsOn;
    }

    public function isEnabledDownloadableFiles()
    {
        return (bool) $this->getConfig()->getConfigParam( "blEnableDownloads" );
    }

    public function showRememberMe()
    {
        return (bool) $this->getConfig()->getConfigParam('blShowRememberMe');
    }

    public function isVatIncluded()
    {
        $blResult = true;
        $oUser = $this->getUser();
        $oVatSelector = oxNew( 'oxVatSelector' );
        $oConfig = $this->getConfig();

        if ( $oConfig->getConfigParam( 'blEnterNetPrice' ) && $oConfig->getConfigParam( 'bl_perfCalcVatOnlyForBasketOrder' ) ) {
            $blResult = false;
        } elseif ( $oUser && !$oVatSelector->getUserVat( $oUser ) ) {
            $blResult = false;
        }

        return $blResult;
    }

    public function isPriceCalculated()
    {
        return (bool) $this->getConfig()->getConfigParam( 'bl_perfLoadPrice' );
    }

}