oxlang.php

Go to the documentation of this file.

<?php

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

    protected $_iBaseLanguageId = null;

    protected $_iTplLanguageId = null;

    protected $_iEditLanguageId = null;

    protected $_aLangCache = null;

    protected $_aAdminLangCache = null;

    public static function getInstance()
    {
        if ( defined('OXID_PHP_UNIT')) {
            if ( ($oClassMod = modInstances::getMod(__CLASS__))  && is_object($oClassMod) ) {
                return $oClassMod;
            } else {
                $inst = oxNew( 'oxLang' );
                 modInstances::addMod( __CLASS__, $inst );
                 return $inst;
            }
        }

        if ( !self::$_instance instanceof oxLang ) {

            self::$_instance = oxNew( 'oxLang');
        }
        return self::$_instance;
    }

    public function resetBaseLanguage()
    {
        $this->_iBaseLanguageId = null;
    }

    public function getBaseLanguage()
    {
        $myConfig = $this->getConfig();
        //$this->_iBaseLanguageId = null;

        if ( $this->_iBaseLanguageId !== null ) {
            return $this->_iBaseLanguageId;
        }

        $blAdmin = $this->isAdmin();

        // languages and search engines
        if ( $blAdmin && ( ( $iSeLang = oxConfig::getParameter( 'changelang' ) ) !== null ) ) {
            $this->_iBaseLanguageId = $iSeLang;
        }

        if ( is_null( $this->_iBaseLanguageId ) ) {
            $this->_iBaseLanguageId = oxConfig::getParameter( 'lang' );
        }

        //or determining by domain
        $aLanguageUrls = $myConfig->getConfigParam( 'aLanguageURLs' );

        if ( !$blAdmin && is_array( $aLanguageUrls ) ) {
            foreach ( $aLanguageUrls as $iId => $sUrl ) {
                if ( $myConfig->isCurrentUrl( $sUrl ) ) {
                    $this->_iBaseLanguageId = $iId;
                    break;
                }
            }
        }

        if ( is_null( $this->_iBaseLanguageId ) ) {
            $this->_iBaseLanguageId = oxConfig::getParameter( 'language' );
        }

        if ( is_null( $this->_iBaseLanguageId ) ) {
            $this->_iBaseLanguageId = $myConfig->getConfigParam( 'sDefaultLang' );
        }

        $this->_iBaseLanguageId = (int) $this->_iBaseLanguageId;

        // validating language
        $this->_iBaseLanguageId = $this->validateLanguage( $this->_iBaseLanguageId );

        return $this->_iBaseLanguageId;
    }

    public function getTplLanguage()
    {
        if ( $this->_iTplLanguageId !== null ) {
            return $this->_iTplLanguageId;
        }

        if ( !$this->isAdmin() ) {
            $this->_iTplLanguageId = $this->getBaseLanguage();
        } else {
            //admin area

            if ( is_null( $this->_iTplLanguageId ) ) {
                //$this->_iTplLanguageId = oxConfig::getParameter( 'tpllanguage' );
                $this->_iTplLanguageId = oxSession::getVar( 'tpllanguage' );
            }

            if ( is_null( $this->_iTplLanguageId ) ) {
                $this->_iTplLanguageId = $this->getBaseLanguage();
            }
        }

        // validating language
        $this->_iTplLanguageId = $this->validateLanguage( $this->_iTplLanguageId );

        return $this->_iTplLanguageId;
    }

    public function getEditLanguage()
    {
        if ( $this->_iEditLanguageId !== null ) {
            return $this->_iEditLanguageId;
        }

        if ( !$this->isAdmin() ) {
            $this->_iEditLanguageId = $this->getBaseLanguage();
        } else {
            $this->_iEditLanguageId = oxConfig::getParameter( 'editlanguage' );

            // check if we really need to set the new language
            if ( "saveinnlang" == $this->getConfig()->getActiveView()->getFncName() ) {
                $iNewLanguage = oxConfig::getParameter( "new_lang");
            }

            if ( isset( $iNewLanguage ) ) {
                if ( isset( $iNewLanguage ) ) {
                    $this->_iEditLanguageId = $iNewLanguage;
                    oxSession::deleteVar( "new_lang" );
                }
            }

            if ( is_null( $this->_iEditLanguageId ) ) {
                $this->_iEditLanguageId = $this->getBaseLanguage();
            }
        }

        // validating language
        $this->_iEditLanguageId = $this->validateLanguage( $this->_iEditLanguageId );

        return $this->_iEditLanguageId;
    }

    public function getLanguageArray( $iLanguage = null )
    {
        $myConfig = oxConfig::getInstance();

        if ( is_null($iLanguage) ) {
            $iLanguage = $this->_iBaseLanguageId;
        }

        $aLanguages = array();
        $aConfLanguages = $myConfig->getConfigParam( 'aLanguages' );
        if ( is_array( $aConfLanguages ) ) {

            $i = 0;
            reset( $aConfLanguages );
            while ( list( $key, $val ) = each( $aConfLanguages ) ) {
                if ( $val) {
                    $oLang = new oxStdClass();
                    $oLang->id   = $i;
                    $oLang->abbr = $key;
                    $oLang->name = $val;
                    if ( isset( $iLanguage ) && $i == $iLanguage ) {
                        $oLang->selected = 1;
                    } else {
                        $oLang->selected = 0;
                    }
                    $aLanguages[$i] = $oLang;
                }
                ++$i;
            }
        }
        return $aLanguages;
    }

    public function getLanguageAbbr( $iLanguage = null)
    {
        $myConfig = oxConfig::getInstance();

        if ( !isset($iLanguage) ) {
            $iLanguage = $this->_iBaseLanguageId;
        }

        $aLangAbbr = $this->getLanguageIds();

        if ( isset($iLanguage,$aLangAbbr[$iLanguage]) ) {
            return $aLangAbbr[$iLanguage];
        }

        return $iLanguage;
    }

    public function getLanguageNames()
    {
        return array_values(oxConfig::getInstance()->getConfigParam( 'aLanguages' ));
    }

    public function getLanguageIds()
    {
        return array_keys(oxConfig::getInstance()->getConfigParam( 'aLanguages' ));
    }

    public function translateString( $sStringToTranslate, $iLang = null, $blAdminMode = null )
    {
        $aLangCache = $this->_getLangTranslationArray( $iLang, $blAdminMode );
        if ( isset( $aLangCache[$sStringToTranslate] ) ) {
            $sText = $aLangCache[$sStringToTranslate];
        } else {
            $sText = $sStringToTranslate;
        }

            $blIsAdmin = isset( $blAdminMode ) ? $blAdminMode : $this->isAdmin();
            if ( !$blIsAdmin && $sText === $sStringToTranslate ) {
                $sText = $this->_readTranslateStrFromTextFile( $sStringToTranslate, $iLang, $blIsAdmin );
            }

        return $sText;
    }

    public function formatCurrency( $dValue, $oActCur = null )
    {
        if ( !$oActCur ) {
            $oActCur = $this->getConfig()->getActShopCurrencyObject();
        }
        return number_format( $dValue, $oActCur->decimal, $oActCur->dec, $oActCur->thousand );
    }

    public function formatVat( $dValue, $oActCur = null )
    {   
        $iDecPos = 0;
        $sValue  = ( string ) $dValue;
        if ( ( $iDotPos = strpos( $sValue, '.' ) ) !== false ) {
            $iDecPos = strlen( substr( $sValue, $iDotPos + 1 ) );
        }

        $oActCur = $oActCur ? $oActCur : $this->getConfig()->getActShopCurrencyObject();
        $iDecPos = ( $iDecPos < $oActCur->decimal ) ? $iDecPos : $oActCur->decimal;          
        return number_format( $dValue, $iDecPos, $oActCur->dec, $oActCur->thousand );
    }

    public function getLanguageTag( $iLanguage = null)
    {
        if ( !isset( $iLanguage ) ) {
            $iLanguage = $this->getBaseLanguage();
        }

        $iLanguage = (int) $iLanguage;

        return ( ( $iLanguage )?"_$iLanguage":"" );
    }

    protected function _getLangTranslationArray( $iLang = null, $blAdminMode = null )
    {
        startProfile("_getLangTranslationArray");
        $myConfig = $this->getConfig();
        $sFileName = '';
        $sCustFileName = '';

        $blAdminMode = isset( $blAdminMode ) ? $blAdminMode : $this->isAdmin();

        $iLang  = ( $iLang === null )?oxSession::getVar( 'blAdminTemplateLanguage' ):$iLang;
        if ( !isset( $iLang ) ) {
            $iLang = $this->getBaseLanguage();
            if ( !isset( $iLang ) ) {
                $iLang = 0;
            }
        }

        if ( $blAdminMode ) {
            $aLangCache = $this->_aAdminLangCache;
        } else {
            $aLangCache = $this->_aLangCache;
        }

        // casting for security reasons
        $iLang = (int) $iLang;
        if ( !$aLangCache[$iLang] ) {

            /*
            $sFileName     = $myConfig->getLanguagePath('lang.php', $blAdminMode,$iLang);
            $sCustFileName = $myConfig->getLanguagePath('cust_lang.php', $blAdminMode,$iLang);
            */
            $sCacheName = "languagefiles_".$blAdminMode."_".$iLang."_".$this->getConfig()->getShopId();
            $aLangFiles = oxUtils::getInstance()->fromFileCache($sCacheName);
            if (!$aLangFiles) {
                $sDir = dirname($myConfig->getLanguagePath('lang.php', $blAdminMode, $iLang));

                //get all lang files
                $aLangFiles = glob($sDir."/*lang.php");

                //save to cache
                oxUtils::getInstance()->toFileCache($sCacheName, $aLangFiles);
            }

            $aLangCache[$iLang] = array();
            foreach ($aLangFiles as $sLangFile) {
                require $sLangFile;
                $aLangCache[$iLang] = array_merge( $aLangCache[$iLang], $aLang);
            }


            //build lang array
            /*
            if ( is_file( $sFileName ) ) {
                require $sFileName;
                $aLangCache[$iLang] = $aLang;
            }

            if ( is_file( $sCustFileName ) ) {
                require $sCustFileName;
                $aLangCache[$iLang] = array_merge( $aLangCache[$iLang], $aLang);
            }*/

            if ( $blAdminMode ) {
                $this->_aAdminLangCache = $aLangCache;
            } else {
                $this->_aLangCache = $aLangCache;
            }
        }


        stopProfile("_getLangTranslationArray");

        // if language array exists ..
        if ( isset( $aLangCache[$iLang] ) ) {
            return $aLangCache[$iLang];
        } else {
            return array();
        }
    }

    protected function _readTranslateStrFromTextFile( $sStringToTranslate, $iLang = null, $blIsAdmin = null )
    {
        $iLang  = ( $iLang === null )?oxSession::getVar( 'blAdminTemplateLanguage' ):$iLang;
        if ( !isset( $iLang ) ) {
            $iLang = $this->getBaseLanguage();
            if ( !isset( $iLang ) ) {
                $iLang = 0;
            }
        }

        $blIsAdmin = isset( $blIsAdmin ) ? $blIsAdmin : $this->isAdmin();
        $sFileName = $this->getConfig()->getLanguagePath('lang.txt', $blIsAdmin, $iLang);

        if ( is_file ( $sFileName ) ) {

            static $aUserLangCache = array();

            if ( !isset( $aUserLangCache[$sFileName] ) ) {
                $handle = @fopen( $sFileName, "r" );
                if ( $handle === false ) {
                    return $sStringToTranslate;
                }

                $contents = fread( $handle, filesize ( $sFileName ) );
                fclose( $handle );
                $fileArray = explode( "\n", $contents );
                $aUserLangCache[$sFileName] = array();
                $aLang = &$aUserLangCache[$sFileName];

                while ( list( $nr,$line ) = each( $fileArray ) ) {
                    $line = ltrim( $line );
                    if ( $line[0]!="#" and strpos( $line, "=" ) > 0 ) {
                        $index = trim( substr( $line, 0, strpos($line, "=" ) ) );
                        $value = trim( substr( $line, strpos( $line, "=" ) + 1, strlen( $line ) ) );
                        $aLang[trim($index)] = trim($value);
                    }
                }
            }

            if ( !isset( $aLang ) && isset( $aUserLangCache[$sFileName] ) ) {
                $aLang = &$aUserLangCache[$sFileName];
            }

            if ( isset( $aLang[$sStringToTranslate] ) ) {
                return $aLang[$sStringToTranslate];
            }
        }

        return $sStringToTranslate;
    }

    public function validateLanguage( $iLang = null )
    {
        $iLang = (int) $iLang;

        // checking if this language is valid
        $aLanguages = $this->getLanguageArray();

        if ( !isset( $aLanguages[$iLang] ) && is_array( $aLanguages ) ) {
            $oLang = current( $aLanguages );
            $iLang = $oLang->id;
        }

        return $iLang;
    }

    public function setBaseLanguage( $iLang = null )
    {
        if ( is_null($iLang) ) {
            $iLang = $this->getBaseLanguage();
        } else {
            $this->_iBaseLanguageId = (int) $iLang;
        }

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            modSession::getInstance();
        }

        oxSession::setVar( 'language', $iLang );
    }

    public function setTplLanguage( $iLang = null )
    {
        if ( is_null($iLang) ) {
            $iLang = $this->getTplLanguage();
        } else {
            $this->_iTplLanguageId = (int) $iLang;
        }

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            modSession::getInstance();
        }

        oxSession::setVar( 'tpllanguage', $iLang );
    }

}

---