oxutilsurl.php

Go to the documentation of this file.

<?php

class oxUtilsUrl extends oxSuperCfg
{
    private static $_instance = null;

    protected $_aAddUrlParams = null;

    public static function getInstance()
    {
        // disable caching for test modules
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

        if ( !(self::$_instance instanceof oxUtilsUrl ) ) {
            self::$_instance = oxNew( 'oxUtilsUrl' );
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }
        return self::$_instance;
    }

    public function getBaseAddUrlParams()
    {
        $aAddUrlParams = array();

        return $aAddUrlParams;
    }

    public function getAddUrlParams()
    {
        if ( $this->_aAddUrlParams === null ) {
            $this->_aAddUrlParams = $this->getBaseAddUrlParams();

            // appending currency
            if ( ( $iCur = oxConfig::getParameter( 'currency' ) ) ) {
                $this->_aAddUrlParams['cur'] = $iCur;
            }
        }
        return $this->_aAddUrlParams;
    }

    public function prepareUrlForNoSession( $sUrl )
    {
        if ( oxUtils::getInstance()->seoIsActive() ) {
            return $sUrl;
        }

        $sUrl = preg_replace('/(force_)?(admin_)?sid=[a-z0-9\._]*&?(amp;)?/i', '', $sUrl);

        $oStr = getStr();
        if ($qpos = $oStr->strpos($sUrl, '?')) {
            if ($qpos == $oStr->strlen($sUrl)-1) {
                $sSep = '';
            } else {
                $sSep = '&amp;';
            }
        } else {
            $sSep = '?';
        }

        if (!preg_match('/[&?](amp;)?lang=[0-9]+/i', $sUrl)) {
            $sUrl .= "{$sSep}lang=".oxLang::getInstance()->getBaseLanguage();
            $sSep = '&amp;';
        }

        if (!preg_match('/[&?](amp;)?cur=[0-9]+/i', $sUrl)) {
            $iCur = (int) oxConfig::getParameter('currency');
            if ( $iCur ) {
                $sUrl .= "{$sSep}cur=".$iCur;
                $sSep = '&amp;';
            }
        }

        return $sUrl;
    }

    protected function _appendUrl( $sUrl, $aAddParams )
    {
        $sSep = '&amp;';
        if ( getStr()->strpos( $sUrl, '?' ) === false ) {
            $sSep = '?';
        }

        if ( count( $aAddParams ) ) {

            foreach ( $aAddParams as $sName => $sValue ) {
                if ( $sValue && !preg_match("/\?(.*&(amp;)?)?$sName=/", $sUrl)) {
                    $sUrl .= $sSep . $sName . "=" . $sValue;
                    $sSep = '&amp;';
                }
            }
        }
        if ($sUrl) {
            return $sUrl.$sSep;
        }
        return '';
    }

    public function processUrl( $sUrl, $blFinalUrl = true, $aParams = null, $iLang = null )
    {
        $aAddParams = $this->getAddUrlParams();
        if ( is_array($aParams) && count( $aParams ) ) {
            $aAddParams = array_merge( $aAddParams, $aParams );
        }

        $ret = oxSession::getInstance()->processUrl(
                    oxLang::getInstance()->processUrl(
                        $this->_appendUrl( 
                                $sUrl, 
                                $aAddParams
                        ),
                        $iLang
                    )
                );

        if ($blFinalUrl) {
            $ret = preg_replace('/(\?|&(amp;)?)$/', '', $ret);
        }
        return $ret;
    }

    public function processSeoUrl( $sUrl )
    {
        $ret = $this->getSession()->processUrl( $this->_appendUrl( $sUrl, $this->getAddUrlParams() ) );
        $ret = preg_replace('/(\?|&(amp;)?)$/', '', $ret);
        return $ret;
    }

    public function processStdUrl( $sUrl, $aParams, $iLang, $blAddLangParam )
    {
        return $this->processUrl($sUrl, true, $aParams, $iLang);
    }

    public function appendParamSeparator($sUrl)
    {
        if (preg_match('/(\?|&(amp;)?)$/i', $sUrl)) {
            // it is already ok
            return $sUrl;
        }
        if (strpos($sUrl, '?') === false) {
            return $sUrl.'?';
        }
        return $sUrl.'&amp;';
    }
}