Source for file jLocale.class.php

Documentation is available at jLocale.class.php

<?php
/**
* @package jelix
* @subpackage core
* @author Laurent Jouanneau
* @author Gerald Croes
* @contributor Julien Issler, Yannick Le Guédart
* Some parts of this file are took from Copix Framework v2.3dev20050901, CopixI18N.class.php, http://www.copix.org.
* copyrighted by CopixTeam and released under GNU Lesser General Public Licence.
* initial authors : Gerald Croes, Laurent Jouanneau.
* enhancement by Laurent Jouanneau for Jelix.
* @link http://www.jelix.org
* @licence GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
*/
/**
* static class to get a localized string
* @package jelix
* @subpackage core
*/
class jLocale {
/**
*
*/
static $bundles = array();
/**
* static class...
*/
private function __construct(){}
/**
* gets the current lang
* @return string
*/
static function getCurrentLang(){
$s=jApp::config()->locale;
return substr($s,0, strpos($s,'_'));
}
/**
* gets the current country.
* @return string
*/
static function getCurrentCountry (){
$s = jApp::config()->locale;
return substr($s,strpos($s,'_')+1);
}
/**
* gets the correct string, for a given language.
* if it can't get the correct language, it will try to gets the string
* from the default language.
* if both fails, it will raise an exception.
* @param string $key the key of the localized string
* @param array $args arguments to apply to the localized string with sprintf
* @param string $locale the lang code. if null, use the default language
* @param string $charset the charset code. if null, use the default charset
* @return string the localized string
*/
static function get ($key, $args=null, $locale=null, $charset=null) {
$config = jApp::config();
try {
$file = new jSelectorLoc($key, $locale, $charset);
}
catch (jExceptionSelector $e) {
// the file is not found
if ($e->getCode() == 12) throw $e;
if ($locale === null) $locale = $config->locale;
if ($charset === null) $charset = $config->charset;
if ($locale != $config->fallbackLocale && $config->fallbackLocale) {
return jLocale::get ($key, $args, $config->fallbackLocale, $charset);
}
else
throw new Exception('(200)The given locale key "'.$key
.'" is invalid (for charset '.$charset
.', lang '.$locale.')');
}
$locale = $file->locale;
$keySelector = $file->module.'~'.$file->fileKey;
if (!isset (self::$bundles[$keySelector][$locale])) {
self::$bundles[$keySelector][$locale] = new jBundle ($file, $locale);
}
$bundle = self::$bundles[$keySelector][$locale];
//try to get the message from the bundle.
$string = $bundle->get ($file->messageKey, $file->charset);
if ($string === null) {
if ($locale == $config->fallbackLocale) {
throw new Exception('(210)The given locale key "'.$file->toString().'" does not exists in the default lang and in the fallback lang for the '.$file->charset.' charset');
}
// if the message was not found, we're gonna
//use the default language and country.
else if ($locale == $config->locale) {
if ($config->fallbackLocale)
return jLocale::get ($key, $args, $config->fallbackLocale, $charset);
throw new Exception('(210)The given locale key "'.$file->toString().'" does not exists in the default lang for the '.$file->charset.' charset');
}
return jLocale::get ($key, $args, $config->locale);
}
else {
//here, we know the message
if ($args !== null && $args !== array()) {
$string = call_user_func_array('sprintf', array_merge (array ($string), is_array ($args) ? $args : array ($args)));
}
return $string;
}
}
/**
* says if the given locale or lang code is available in the application
* @param string $locale the locale code (xx_YY) or a lang code (xx)
* @param boolean $strictCorrespondance if true don't try to find a locale from an other country
* @return string the corresponding locale
*/
static function getCorrespondingLocale($l, $strictCorrespondance=false) {
if (strpos($l, '_') === false) {
$l = self::langToLocale($l);
}
if ($l != '') {
$avLoc = &jApp::config()->availableLocales;
if (in_array($l, $avLoc)) {
return $l;
}
if ($strictCorrespondance)
return '';
$l2 = self::langToLocale(substr($l, 0, strpos($l, '_')));
if ($l2 != $l && in_array($l2, $avLoc)) {
return $l2;
}
}
return '';
}
/**
* returns the locale corresponding of one of the accepted language indicated
* by the browser, and which is available in the application.
* @return string the locale. empty if not found.
*/
static function getPreferedLocaleFromRequest() {
if (!isset($_SERVER['HTTP_ACCEPT_LANGUAGE']))
return '';
$languages = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
foreach ($languages as $bl) {
if (!preg_match("/^([a-zA-Z]{2,3})(?:[-_]([a-zA-Z]{2,3}))?(;q=[0-9]\\.[0-9])?$/",$bl,$match))
continue;
$l = strtolower($match[1]);
if (isset($match[2]))
$l .= '_'.strtoupper($match[2]);
$lang = self::getCorrespondingLocale($l);
if ($lang != '')
return $lang;
}
return '';
}
/**
* @var array content of the lang_to_locale.ini.php
*/
static protected $langToLocale = null;
/**
* returns the locale corresponding to a lang.
*
* The file lang_to_locale give corresponding locale, but you can override these
* association into the langToLocale section of the main configuration
* @param string $lang a lang code (xx)
* @return string the corresponding locale (xx_YY)
*/
static function langToLocale($lang) {
$conf = jApp::config();
if (isset($conf->langToLocale[$lang]))
return $conf->langToLocale[$lang];
if (is_null(self::$langToLocale)) {
self::$langToLocale = @parse_ini_file(JELIX_LIB_CORE_PATH.'lang_to_locale.ini.php');
}
if (isset(self::$langToLocale[$lang])) {
return self::$langToLocale[$lang];
}
return '';
}
}

Documentation generated on Wed, 04 Jan 2017 22:55:45 +0100 by phpDocumentor 1.4.3