Source for file LangEngine.class.php

Documentation is available at LangEngine.class.php

<?php
/**
* Internationalization
*
* ManiaLib provides a simple way to internationalize your application. The good
* news is it uses the same dictionary format as the dictionary feature implemented
* in ManiaLinks. The advantage of using the internationalization features of
* ManiaLib over classic Manialink dictionaries is the ability of making dynamic
* sentences (eg. "Hello 'login'!" where login is from a variable).
*
* How to use it?
*
* First, make sure that the parameter "lang" is in the session. To achieve that,
* you need to use a link with "addplayerid" and then save the parameter in the
* session. If you use the MVC framework, you can add the RegisterRequestParametersFilter
* to your controller (it will look for the lang parameter in the URL and save
* it automatically in the session).
*
* Then, put your dictionary files in the APP_LANGS_PATH directory. You must use
* same structure as classic Manialink dictionary, but you can add placeholders
* for variables using '[1]', '[2]', etc. (without the quotes).
*
* <code>
* <?xml version="1.0"?>
* <dico>
* <language id="en">
* <hello_world>Hello World!</hello_world>
* <hello_login>Hello [1] !</hello_login>
* <the_xx_is_yy>The [1] is [2].</the_xx_is_yy>
* </language>
* </dico>
* </code>
*
* Then you can use the translations in your views using the __() function:
*
* <code>
* __("hello_world"); // returns "Hello world!"
* __("hello_login", "gou1"); // Returns "Hello gou1!"
* __("the_xx_is_yy", "car", "blue"); // Returns "The car is blue."
* __("Bla bla bla"); // Returns "Bla bla bla", ie. the word ID itself when it is not found.
* </code>
*
* You can also internationalize dates:
*
* <code>
* $timestamp = time();
* __date($timestamp); // Returns, for example: "Friday, July 3rd 2009"
* </code>
*
* @author Maxime Raoust
* @package ManiaLib
* @subpackage Internationalization
*/
/**
* i18n core class
* You shouldn't have to do anything with it. Use "__()" & "__date()" instead
* @see __()
* @package ManiaLib
* @subpackage Internationalization
* @ignore
*/
class LangEngine
{
protected $currentLang = "en";
public $dico;
protected static $instance;
/**
* Get the translation of the given text ID
*/
public static function getTranslation($textId, $lang=null)
{
$instance = self::getInstance();
return $instance->getTranslationPrivate($textId, $instance->currentLang);
}
public static function getInstance()
{
if (!self::$instance)
{
$class = __CLASS__;
self::$instance = new $class();
}
return self::$instance;
}
protected function __construct()
{
if(APP_LANG_ENGINE_MODE == APP_LANG_ENGINE_MODE_STATIC)
{
throw new Exception('LANG_ENGINE_MODE_STATIC can not be used with the LangEngine');
}
$session = SessionEngine::getInstance();
$this->currentLang = $session->get("lang", "en");
if(!APP_DEBUG_LEVEL && $dico = $session->get(__CLASS__))
{
$this->dico = unserialize(($dico));
}
else
{
$this->loadDicoRecursive(APP_FRAMEWORK_LANGS_PATH);
$this->loadDicoRecursive(APP_LANGS_PATH);
$session->set(__CLASS__, (serialize($this->dico)));
}
}
/**
* Recursive loading method
*/
protected function loadDicoRecursive($directoryPath)
{
if ($handle = opendir($directoryPath))
{
while (false !== ($file = readdir($handle)))
{
if(substr($file, 0, 1)==".")
{
continue;
}
if(is_dir($directoryPath.$file))
{
$this->loadDicoRecursive($directoryPath.$file);
}
elseif(substr($file, -4)==".xml")
{
$this->parseLangFile($directoryPath."/".$file);
}
}
closedir($handle);
}
}
/**
* Parse an XML dictonary
*/
protected function parseLangFile($file)
{
$dom = new DomDocument;
$dom->load($file);
$languages = $dom->getElementsByTagName("language");
foreach($languages as $language)
{
if($language->hasAttribute("id"))
{
$lang = $language->getAttribute("id");
foreach($language->childNodes as $word)
{
if($word->nodeType == XML_ELEMENT_NODE)
{
$this->dico[$lang][$word->nodeName] = (string) $word->nodeValue;
}
}
}
}
}
/**
* Get the transaltion of the given text ID
* @return string
*/
protected function getTranslationPrivate($textId, $lang="en")
{
if(isset($this->dico[$lang][$textId]))
{
return $this->dico[$lang][$textId];
}
elseif(isset($this->dico["en"][$textId]))
{
return $this->dico["en"][$textId];
}
else
{
return $textId;
}
}
}
/**
* i18n message
*
* To use with APP_LANG_ENGINE_MODE_DYNAMIC
*
* Example:
* <code>
* echo __("hello_world");
* echo __("hello_login", $someLogin);
* </code>
* @param string
* @return string
*/
function __($textId)
{
$str = LangEngine::getTranslation($textId);
$i=1;
$args = func_get_args();
$search = array();
$replace = array();
while(strpos($str, "[$i]")!==false)
{
$search[] = "[$i]";
if(isset($args[$i]))
{
$replace[] = $args[$i];
}
else
{
$replace[] = "";
}
$i++;
}
$str = str_replace($search, $replace, $str);
return $str;
}
/**
* i18n date
*
* To use with APP_LANG_ENGINE_MODE_DYNAMIC
*
* @param int Unix timestamp
* @return string
*/
function __date($timestamp)
{
if(!$timestamp)
{
return "-";
}
$return=__("date_long",
__( strtolower(date("l", $timestamp)) ), // Day name
__( strtolower(date("F", $timestamp)) ), // Month name
date("j", $timestamp), // Day number
__( "date_ordinal_suffix", date("S", $timestamp) ), // Suffix
date("Y", $timestamp) // Year
);
if($return=="date_long")
{
return date("Y/M/j", $timestamp);
}
else
{
return $return;
}
}
?>

ManiaLib 1.0b1 API Reference

Source for file LangEngine.class.php