oxviewconfig.php

Go to the documentation of this file.

<?php

class oxViewConfig extends oxSuperCfg
{
    protected $_oShop = null;

    protected $_aViewData = null;

    protected $_aConfigParams = array();

    public function getHomeLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'homeLink' ) ) === null ) {
            $myConfig = $this->getConfig();
            $myUtils  = oxUtils::getInstance();
            $oLang    = oxLang::getInstance();

            $sValue = null;


            $iLang = $oLang->getBaseLanguage();
            if ( $myUtils->seoIsActive() && !$sValue && ( $iLang != $myConfig->getConfigParam( 'sDefaultLang' ) ) ) {
                $sValue = oxSeoEncoder::getInstance()->getStaticUrl( $this->getSelfLink() . 'cl=start', $iLang );
            }

            if ( !$sValue ) {
                $sValue = getStr()->preg_replace('#index.php\??$#', '', $this->getSelfLink());
            }

            $this->setViewConfigParam( 'homeLink', $sValue );
        }
        return $sValue;
    }

    public function getActTplName()
    {
        $sTplName = oxConfig::getParameter( 'tpl' );
        // #M1176: Logout from CMS page
        if ( !$sTplName ) {
            $sTplName = $this->getViewConfigParam('tpl');
        }
        return $sTplName ? basename( $sTplName ) : null;
    }

    public function getLogoutLink()
    {
        $sClass   = $this->getActiveClassName();
        $sCatnid  = $this->getActCatId();
        $sTplName = $this->getActTplName();

        return $this->getConfig()->getShopHomeURL()."cl={$sClass}&amp;".( $sCatnid ? "cnid={$sCatnid}" : '' )."&amp;fnc=logout".( $sTplName ? "&amp;tpl=".basename( $sTplName ) : '' )."&amp;redirect=1";
    }

    public function getHelpLink()
    {
        $sTplName = $this->getActTplName();
        $sClass   = $this->getActiveClassName();
        return $this->getConfig()->getShopCurrentURL()."cl=help&amp;page={$sClass}".( $sTplName ? "&amp;tpl={$sTplName}" : '' );
    }

    public function getActCatId()
    {
        return oxConfig::getParameter( 'cnid' );
    }

    public function getActManufacturerId()
    {
        return oxConfig::getParameter( 'mnid' );
    }

    public function getTypeLinkParams()
    {
        $sLink = '';
        if ( ( $sId = $this->getActCatId() ) ) {
            $sLink .= "cnid={$sId}";
        }
        if ( ( $sId = $this->getActManufacturerId() ) ) {
            $sLink .= "mnid={$sId}";
        }

        return $sLink;
    }

    public function getTypeParams()
    {
        $sForm = '';
        if ( ( $sId = $this->getActCatId() ) ) {
            $sForm .= "<input type=\"hidden\" name=\"cnid\" value=\"{$sId}\">\n";
        }
        if ( ( $sId = $this->getActManufacturerId() ) ) {
            $sForm .= "<input type=\"hidden\" name=\"mnid\" value=\"{$sId}\">\n";
        }

        return $sForm;
    }

    public function setViewConfigParam( $sName, $sValue )
    {
        startProfile('oxviewconfig::setViewConfigParam');

        $this->_aConfigParams[$sName] = $sValue;

        stopProfile('oxviewconfig::setViewConfigParam');
    }

    public function getViewConfigParam( $sName )
    {
        startProfile('oxviewconfig::getViewConfigParam');

        if ( $this->_oShop && isset( $this->_oShop->$sName ) ) {
            $sValue = $this->_oShop->$sName;
        } elseif ( $this->_aViewData && isset( $this->_aViewData[ $sName ] ) ) {
            $sValue = $this->_aViewData[ $sName ];
        } else {
            $sValue = ( isset( $this->_aConfigParams[ $sName ] ) ? $this->_aConfigParams[ $sName ] : null );
        }

        stopProfile('oxviewconfig::getViewConfigParam');

        return $sValue;
    }

    public function setViewShop( $oShop, $aViewData )
    {
        $this->_oShop     = $oShop;
        $this->_aViewData = $aViewData;
    }

    public function __call( $sMethodName, $sParams )
    {
        startProfile('oxviewconfig::__call');
        if ( stripos( $sMethodName, 'get' ) === 0 ) {
            return $this->getViewVar( substr( $sMethodName, 3 ) );
        }
        stopProfile('oxviewconfig::__call');
    }

    public function getSessionId()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'sessionid' ) ) === null ) {
            $sValue = $this->getSession()->getId();
            $this->setViewConfigParam( 'sessionid', $sValue );
        }
        return $sValue;
    }

    public function getHiddenSid()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'hiddensid' ) ) === null ) {
            $sValue = $this->getSession()->hiddenSid();

            // appending language info to form
            if ( ( $sLang = oxLang::getInstance()->getFormLang() ) ) {
                $sValue .= "\n{$sLang}";
            }


            $this->setViewConfigParam( 'hiddensid', $sValue );
        }
        return $sValue;
    }

    public function getSelfLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'selflink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopHomeURL();
            $this->setViewConfigParam( 'selflink', $sValue );
        }
        return $sValue;
    }

    public function getSslSelfLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'sslselflink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopSecureHomeURL();
            $this->setViewConfigParam( 'sslselflink', $sValue );
        }
        return $sValue;
    }

    public function getBaseDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'basedir' ) ) === null ) {
            $sValue = $this->getConfig()->getShopURL();
            $this->setViewConfigParam( 'basedir', $sValue );
        }
        return $sValue;
    }

    public function getCoreUtilsDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'coreutilsdir' ) ) === null ) {
            $sValue = $this->getConfig()->getCoreUtilsURL();
            $this->setViewConfigParam( 'coreutilsdir', $sValue );
        }
        return $sValue;
    }

    public function getSelfActionLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'selfactionlink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopCurrentUrl();
            $this->setViewConfigParam( 'selfactionlink', $sValue );
        }
        return $sValue;
    }

    public function getCurrentHomeDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'currenthomedir' ) ) === null ) {
            $sValue = $this->getConfig()->getCurrentShopUrl();
            $this->setViewConfigParam( 'currenthomedir', $sValue );
        }
        return $sValue;
    }

    public function getBasketLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'basketlink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopHomeURL()   . 'cl=basket';
            $this->setViewConfigParam( 'basketlink', $sValue );
        }
        return $sValue;
    }

    public function getOrderLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'orderlink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopSecureHomeUrl() . 'cl=user';
            $this->setViewConfigParam( 'orderlink', $sValue );
        }
        return $sValue;
    }

    public function getPaymentLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'paymentlink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopSecureHomeUrl() . 'cl=payment';
            $this->setViewConfigParam( 'paymentlink', $sValue );
        }
        return $sValue;
    }

    public function getExeOrderLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'exeorderlink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopSecureHomeUrl() . 'cl=order&amp;fnc=execute';
            $this->setViewConfigParam( 'exeorderlink', $sValue );
        }
        return $sValue;
    }

    public function getOrderConfirmLink()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'orderconfirmlink' ) ) === null ) {
            $sValue = $this->getConfig()->getShopSecureHomeUrl() . 'cl=order';
            $this->setViewConfigParam( 'orderconfirmlink', $sValue );
        }
        return $sValue;
    }

    public function getResourceUrl()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'basetpldir' ) ) === null ) {
            $sValue = $this->getConfig()->getResourceUrl( null, $this->isAdmin() );
            $this->setViewConfigParam( 'basetpldir', $sValue );
        }
        return $sValue;
    }

    public function getTemplateDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'templatedir' ) ) === null ) {
            $sValue = $this->getConfig()->getTemplateDir( $this->isAdmin() );
            $this->setViewConfigParam( 'templatedir', $sValue );
        }
        return $sValue;
    }

    public function getUrlTemplateDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'urltemplatedir' ) ) === null ) {
            $sValue = $this->getConfig()->getTemplateUrl( $this->isAdmin() );
            $this->setViewConfigParam( 'urltemplatedir', $sValue );
        }
        return $sValue;
    }

    public function getImageUrl()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'imagedir' ) ) === null ) {
            $sValue = $this->getConfig()->getImageUrl( $this->isAdmin() );
            $this->setViewConfigParam( 'imagedir', $sValue );
        }
        return $sValue;
    }

    public function getNoSslImageDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'nossl_imagedir' ) ) === null ) {
            $sValue = $this->getConfig()->getImageUrl( $this->isAdmin(), false );
            $this->setViewConfigParam( 'nossl_imagedir', $sValue );
        }
        return $sValue;
    }

    public function getPictureDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'picturedir' ) ) === null ) {
            $sValue = $this->getConfig()->getPictureUrl( null, $this->isAdmin() );
            $this->setViewConfigParam( 'picturedir', $sValue );
        }
        return $sValue;
    }

    public function getAdminDir()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'sAdminDir' ) ) === null ) {
            $sValue = $this->getConfig()->getConfigParam( 'sAdminDir' );
            $this->setViewConfigParam( 'sAdminDir', $sValue );
        }
        return $sValue;
    }

    public function getActiveShopId()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'shopid' ) ) === null ) {
            $sValue = $this->getConfig()->getShopId();
            $this->setViewConfigParam( 'shopid', $sValue );
        }
        return $sValue;
    }

    public function isSsl()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'isssl' ) ) === null ) {
            $sValue = $this->getConfig()->isSsl();
            $this->setViewConfigParam( 'isssl', $sValue );
        }
        return $sValue;
    }


    public function getRemoteAddress()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'ip' ) ) === null ) {
            $sValue = oxUtilsServer::getInstance()->getRemoteAddress();
            $this->setViewConfigParam( 'ip', $sValue );
        }
        return $sValue;
    }

    public function getPopupIdent()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'popupident' ) ) === null ) {
            $sValue = md5( $this->getConfig()->getShopUrl() );
            $this->setViewConfigParam( 'popupident', $sValue );
        }
        return $sValue;
    }

    public function getPopupIdentRand()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'popupidentrand' ) ) === null ) {
            $sValue = md5( time() );
            $this->setViewConfigParam( 'popupidentrand', $sValue );
        }
        return $sValue;
    }

    public function getArtPerPageForm()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'artperpageform' ) ) === null ) {
            $sValue = $this->getConfig()->getShopCurrentUrl();
            $this->setViewConfigParam( 'artperpageform', $sValue );
        }
        return $sValue;
    }

    public function isBuyableParent()
    {
        return $this->getConfig()->getConfigParam( 'blVariantParentBuyable' );
    }

    public function showBirthdayFields()
    {
        return $this->getConfig()->getConfigParam( 'blShowBirthdayFields' );
    }

    public function showFinalStep()
    {
        return $this->getConfig()->getConfigParam( 'blShowFinalStep' );
    }

    public function getNrOfCatArticles()
    {
        return $this->getConfig()->getConfigParam( 'aNrofCatArticles' );
    }

    public function getShowWishlist()
    {
        return $this->getConfig()->getConfigParam( 'bl_showWishlist' );
    }

    public function getShowCompareList()
    {
        return $this->getConfig()->getConfigParam( 'bl_showCompareList' );
    }

    public function getShowListmania()
    {
        return $this->getConfig()->getConfigParam( 'bl_showListmania' );
    }

    public function getShowOpenIdLogin()
    {
        return $this->getConfig()->getConfigParam( 'bl_showOpenId' );
    }

    public function getShowVouchers()
    {
        return $this->getConfig()->getConfigParam( 'bl_showVouchers' );
    }

    public function getShowGiftWrapping()
    {
        return $this->getConfig()->getConfigParam( 'bl_showGiftWrapping' );
    }

    public function isAutoSearchOnCat()
    {
        return $this->getConfig()->getConfigParam( 'blAutoSearchOnCat' );
    }

    public function getActLanguageId()
    {
        if ( ( $sValue = $this->getViewConfigParam( 'lang' ) ) === null ) {
            $iLang = oxConfig::getParameter( 'lang' );
            $sValue = ( $iLang !== null ) ? $iLang : oxLang::getInstance()->getBaseLanguage();
            $this->setViewConfigParam( 'lang', $sValue );
        }
        return $sValue;
    }

    public function getActiveClassName()
    {
        return $this->getConfig()->getActiveView()->getClassName();
    }

    public function getArtPerPageCount()
    {
        return $this->getViewConfigParam( 'iartPerPage' );
    }

    public function getNavUrlParams()
    {
        if ( ( $sParams = $this->getViewConfigParam( 'navurlparams' ) ) === null ) {
            $sParams = '';
            $aNavParams = $this->getConfig()->getActiveView()->getNavigationParams();
            foreach ( $aNavParams as $sName => $sValue ) {
                if ( isset( $sValue ) ) {
                    if ( $sParams ) {
                        $sParams .= '&amp;';
                    }
                    $sParams .= "{$sName}=".rawurlencode( $sValue );
                }
            }
            if ( $sParams ) {
                $sParams = '&amp;'.$sParams;
            }
            $this->setViewConfigParam( 'navurlparams', $sParams );
        }

        return $sParams;
    }

    public function getNavFormParams()
    {

        if ( ( $sParams = $this->getViewConfigParam( 'navformparams' ) ) === null ) {
            $oStr = getStr();
            $sParams = '';
            $aNavParams = $this->getConfig()->getActiveView()->getNavigationParams();
            foreach ( $aNavParams as $sName => $sValue ) {
                if ( isset( $sValue ) ) {
                    $sParams .= "<input type=\"hidden\" name=\"{$sName}\" value=\"".$oStr->htmlentities( $sValue )."\">\n";
                }
            }
            $this->setViewConfigParam( 'navformparams', $sParams );
        }
        return $sParams;
    }

    public function getStockOnDefaultMessage()
    {
        return $this->getConfig()->getConfigParam( 'blStockOnDefaultMessage' );
    }

    public function getStockOffDefaultMessage()
    {
        return $this->getConfig()->getConfigParam( 'blStockOffDefaultMessage' );
    }

    public function getShopVersion()
    {
        return $this->getViewConfigParam( 'sShopVersion' );
    }

    public function getAjaxLink()
    {
        return $this->getViewConfigParam( 'ajaxlink' );
    }

    public function isMultiShop()
    {
        $oShop = $this->getConfig()->getActiveShop();
        return isset( $oShop->oxshops__oxismultishop ) ? ( (bool) $oShop->oxshops__oxismultishop->value ) : false;
    }

    public function getServiceUrl()
    {
        return $this->getViewConfigParam( 'sServiceUrl' );
    }

    public function __get( $sVarName )
    {
        return $this->getViewVar( $sVarName );
    }

    public function getViewVar( $sVarName )
    {
        startProfile('oxviewconfig::__get');

        $myConfig = $this->getConfig();

        // cached ?
        if ( ( $sVarValue = $this->getViewConfigParam( $sVarName ) ) === null ) {

            // using magic getter instead of waisting memmory on rarelly used variables ..
            switch ( strtolower( $sVarName ) ) {
                case 'sid' :
                    $sVarValue = $this->getSessionId();
                    break;
                case 'hiddensid' :
                    $sVarValue = $this->getHiddenSid();
                    break;
                case 'selflink' :
                    $sVarValue = $this->getSelfLink();
                    break;
                case 'sslselflink' :
                    $sVarValue = $this->getSslSelfLink();
                    break;
                //some different processing for Mall mode
                case 'basedir' :
                    $sVarValue = $this->getBaseDir();
                    break;
                case 'coreutilsdir' :
                    $sVarValue = $this->getCoreUtilsDir();
                    break;
                case 'selfactionlink' :
                    $sVarValue = $this->getSelfActionLink();
                    break;
                //https://.... or http://.... link
                case 'currenthomedir' :
                    $sVarValue = $this->getCurrentHomeDir();
                    break;
                case 'basketlink' :
                    $sVarValue = $this->getBasketLink();
                    break;
                case 'orderlink' :
                    $sVarValue = $this->getOrderLink();
                    break;
                case 'paymentlink' :
                    $sVarValue = $this->getPaymentLink();
                    break;
                case 'exeorderlink' :
                    $sVarValue = $this->getExeOrderLink();
                    break;
                case 'orderconfirmlink' :
                    $sVarValue = $this->getOrderConfirmLink();
                    break;
                case 'basetpldir' :
                    $sVarValue = $this->getResourceUrl();
                    break;
                case 'templatedir' :
                    $sVarValue = $this->getTemplateDir();
                    break;
                case 'urltemplatedir' :
                    $sVarValue = $this->getUrlTemplateDir();
                    break;
                case 'imagedir' :
                    $sVarValue = $this->getImageUrl();
                    break;
                case 'nossl_imagedir' :
                    $sVarValue = $this->getNoSslImageDir();
                    break;
                case 'dimagedir' :
                    $sVarValue = $this->getPictureDir();
                    break;
                //applicable only in admin mode
                //in most case admindir is set to "admin" unless you rename the admin dir
                case 'admindir' :
                    $sVarValue = $this->getAdminDir();
                    break;
                case 'id' :
                    $sVarValue = $this->getActiveShopId();
                    break;
                case 'isssl' :
                    $sVarValue = $this->isSsl();
                    break;
                case 'ip' :
                    $sVarValue = $this->getRemoteAddress();
                    break;
                case 'popupident' :
                    $sVarValue = $this->getPopupIdent();
                    break;
                case 'popupidentrand' :
                    $sVarValue = $this->getPopupIdentRand();
                    break;
                case 'artperpageform' :
                    $sVarValue = $this->getArtPerPageForm();
                    break;
                case 'buyableparent' :
                    $sVarValue = $this->isBuyableParent();
                    break;
                case 'blshowbirthdayfields' :
                    $sVarValue = $this->showBirthdayFields();
                    break;
                case 'blshowfinalstep' :
                    $sVarValue = $this->showFinalStep();
                    break;
                case 'anrofcatarticles' :
                    $sVarValue = $this->getNrOfCatArticles();
                    break;
                case 'blautosearchoncat' :
                    $sVarValue = $this->isAutoSearchOnCat();
                    break;
                case 'cnid' :
                    $sVarValue = $this->getActCatId();
                    break;
                case 'cl' :
                    $sVarValue = $this->getActiveClassName();
                    break;
                case 'tpl' :
                    $sVarValue = $this->getActTplName();
                    break;
                case 'lang' :
                case 'slanguage' :
                    $sVarValue = $this->getActLanguageId();
                    break;
                case 'helplink' :
                    $sVarValue = $this->getHelpLink();
                    break;
                case 'logoutlink' :
                    $sVarValue = $this->getLogoutLink();
                    break;
                case 'iartPerPage':
                    $sVarValue = $this->getArtPerPageCount();
                    break;
                case 'navurlparams':
                    $sVarValue = $this->getNavUrlParams();
                    break;
                case 'navformparams':
                    $sVarValue = $this->getNavFormParams();
                    break;
                case 'blstockondefaultmessage':
                    $sVarValue = $this->getStockOnDefaultMessage();
                    break;
                case 'blstockoffdefaultmessage':
                    $sVarValue = $this->getStockOffDefaultMessage();
                    break;
                case 'sShopVersion':
                    $sVarValue = $this->getShopVersion();
                    break;
                case 'ajaxlink':
                    $sVarValue = $this->getAjaxLink();
                    break;
                case 'ismultishop':
                    $sVarValue = $this->isMultiShop();
                    break;
                case 'sServiceUrl':
                    $sVarValue = $this->getServiceUrl();
                    break;
            }
        }

        $this->setViewConfigParam( $sVarName, $sVarValue );

        stopProfile('oxviewconfig::__get');

        return $sVarValue;
    }

    public function getRemoteAccessToken()
    {
        $sRaToken = oxSession::getInstance()->getRemoteAccessToken();

        return $sRaToken;
    }
}