oxview.php

Go to the documentation of this file.

<?php

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

    protected $_sClassLocation = null;

    protected $_sThisAction = null;

    protected $_oParent = null;

    protected $_blIsComponent = false;

    protected $_sThisTemplate = null;

    protected $_sViewId = null;

    protected $_sClass = null;

    protected $_sFnc = null;

    protected static $_blExecuted = false;

    protected $_sTrustedShopId = null;

    protected $_sTSExcellenceId = null;

    protected $_sCharSet = null;

    protected $_sVersion = null;

    protected $_blDemoVersion = null;

    protected $_blDemoShop = null;

    protected $_iNewsStatus = null;

    protected $_sShopLogo = null;

    protected $_sCategoryId = null;

    protected $_oClickCat = null;

    protected $_blIsCallForCache = false;

    protected $_oViewConf = null;


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

        if ( !$this->_blIsComponent ) {
            // assume that cached components does not affect this method ...
            $this->addGlobalParams();
        }
    }

    public function setViewParameters( $aParams = null )
    {
        $this->_aViewParams = $aParams;
    }

    public function getViewParameter( $sKey )
    {
        $sValue = ( isset( $this->_aViewParams[$sKey] ) ) ? $this->_aViewParams[$sKey] : $this->getConfig()->getRequestParameter( $sKey );

        return $sValue;
    }

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

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

    public function getViewId()
    {
    }

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

    public function addGlobalParams( $oShop = null)
    {
        // by default we allways display newsletter bar
        $this->_iNewsStatus = 1;

        // 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();

        return $oViewConf;
    }

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

    public function getBelboonParam()
    {
        if ( $sBelboon = $this->getSession()->getVariable( 'belboon' ) ) {
            return $sBelboon;
        }
        if ( ( $sBelboon = $this->getConfig()->getRequestParameter( 'belboon' ) ) ) {
            $this->getSession()->setVariable( 'belboon', $sBelboon );
        }

        return $sBelboon;
    }

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

        return $this->_oViewConf;
    }

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

    public function setTemplateName( $sTemplate )
    {
        $this->_sThisTemplate = $sTemplate;
    }

    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 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 setIsComponent( $blIsComponent = null )
    {
        $this->_blIsComponent = $blIsComponent;
    }

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

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


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

                if ( isset ( $sNewAction ) ) {
                    $this->_executeNewAction( $sNewAction );
                }
            } else {
                // was not executed on any level ?
                if ( !$this->_blIsComponent ) {
                    $oEx = oxNew( 'oxSystemComponentException' );
                    $oEx->setMessage( 'ERROR_MESSAGE_SYSTEMCOMPONENT_FUNCTIONNOTFOUND' );
                    $oEx->setComponent( $sFunction );
                    throw $oEx;
                }
            }
        }
    }

    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];

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

            $sUrl = $myConfig->getCurrentShopUrl($this->isAdmin());

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

            $sUrl = oxRegistry::get("oxUtilsUrl")->processUrl($sUrl);

            if ( oxRegistry::getUtils()->seoIsActive() && $sSeoUrl = oxRegistry::get( "oxSeoEncoder" )->getStaticUrl( $sUrl ) ) {
                $sUrl = $sSeoUrl;
            }


            //#M341 do not add redirect parameter
            oxRegistry::getUtils()->redirect( $sUrl, (bool) $myConfig->getRequestParameter( 'redirected' ), 302 );
        }
    }

    public function getAdditionalParams()
    {
        return oxRegistry::get("oxUtilsUrl")->processUrl( '', false );
    }

    public function getTrustedShopId()
    {
        if ( $this->_sTrustedShopId == null ) {
            $this->_sTrustedShopId = false;
            $oConfig = $this->getConfig();
            $aTsType   = $oConfig->getConfigParam( 'tsSealType' );
            $sTsActive = $oConfig->getConfigParam( 'tsSealActive' );
            $aTrustedShopIds = $oConfig->getConfigParam( 'iShopID_TrustedShops' );
            $iLangId = (int) oxRegistry::getLang()->getBaseLanguage();
            if ( $sTsActive && $aTrustedShopIds && $aTsType[$iLangId] == 'CLASSIC' ) {
                // compatibility to old data
                if ( !is_array( $aTrustedShopIds ) && $iLangId == 0 ) {
                    $this->_sTrustedShopId = $aTrustedShopIds;
                }
                if ( is_array( $aTrustedShopIds ) ) {
                    $this->_sTrustedShopId = $aTrustedShopIds[$iLangId];
                }
                if ( strlen( $this->_sTrustedShopId ) != 33 || substr( $this->_sTrustedShopId, 0, 1 ) != 'X' ) {
                    $this->_sTrustedShopId = false;
                }
            }
        }
        return $this->_sTrustedShopId;
    }

    public function getTSExcellenceId()
    {
        if ( $this->_sTSExcellenceId == null ) {
            $this->_sTSExcellenceId = false;
            $oConfig   = $this->getConfig();
            $aTsType   = $oConfig->getConfigParam( 'tsSealType' );
            $sTsActive = $oConfig->getConfigParam( 'tsSealActive' );
            $aTrustedShopIds = $oConfig->getConfigParam( 'iShopID_TrustedShops' );
            $iLangId = (int) oxRegistry::getLang()->getBaseLanguage();
            if ( $sTsActive && $aTrustedShopIds && $aTsType[$iLangId] == 'EXCELLENCE' ) {
                $this->_sTSExcellenceId = $aTrustedShopIds[$iLangId];
            }
        }
        return $this->_sTSExcellenceId;
    }

    public function getCharSet()
    {
        if ( $this->_sCharSet == null ) {
            $this->_sCharSet = oxRegistry::getLang()->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 getRevision()
    {
        return $this->getConfig()->getRevision();
    }

    public function getPackageInfo()
    {
        return $this->getConfig()->getPackageInfo();
    }

    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 isBetaVersion()
    {
        $blbetaVersion = false;

        if ( stripos( $this->getConfig()->getVersion(), 'beta' ) !== false ) {
            $blbetaVersion = true;
        }

        return $blbetaVersion;
    }

    public function isRCVersion()
    {
        $blRCVersion = false;

        if ( stripos( $this->getConfig()->getVersion(), 'rc' ) !== false ) {
            $blRCVersion = true;
        }

        return $blRCVersion;
    }

    public function showBetaNote()
    {
        $blBetaNote = false;

        if ( $this->isBetaVersion() || $this->isRCVersion() ) {
            $blBetaNote = true;
        }

        return $blBetaNote;
    }

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

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

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

    public function getShopLogo()
    {
        if ( $this->_sShopLogo === null ) {
            $this->setShopLogo( $this->getConfig()->getConfigParam( 'sShopLogo' ) );
        }

        return $this->_sShopLogo;
    }

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

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

            $this->_oClickCat = false;
            $oCategory = oxNew( 'oxcategory' );
            if ( $oCategory->load( $this->getCategoryId() ) ) {
                $this->_oClickCat = $oCategory;
            }
        }

        return $this->_oClickCat;
    }

    public function setActCategory( $oCategory )
    {
        $this->_oClickCat = $oCategory;
    }

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

        return $this->_sCategoryId;
    }

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

    public function getErrorDestination()
    {
    }

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

    public function isConnectedWithFb()
    {
        $myConfig = $this->getConfig();

        if ( $myConfig->getConfigParam( "bl_showFbConnect" ) ) {
            $oFb = oxRegistry::get("oxFb");
            return $oFb->isConnected();
        }

        return false;
    }

    public function getFbUserId()
    {
        if ( $this->getConfig()->getConfigParam( "bl_showFbConnect" ) ) {
            $oFb = oxRegistry::get("oxFb");
            return $oFb->getUser();
        }
    }

    public function showFbConnectToAccountMsg()
    {
        if ( $this->getConfig()->getRequestParameter( "fblogin" ) ) {
            if ( !$this->getUser() || ($this->getUser() && $this->getSession()->getVariable( '_blFbUserIdUpdated' ) ) ) {
                return true;
            } else {
                return false;
            }
        }

        return false;
    }

    public function isMall()
    {
            return false;
    }

    public function showRdfa()
    {
        return false;
    }


    public function getSidForWidget()
    {
        $sRet = null;
        $oSession = $this->getSession();

        if (!$oSession->isActualSidInCookie() ) {
            $sRet = $oSession->getId();
        }

        return $sRet;
    }

}