phpDocumentor ZNF
Presentation
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]
ZNF
Packages:
ZNF

Source for file Translation.php

Documentation is available at Translation.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3. /**
  4.  * PHP version 5
  5.  *
  6.  * This source file is subject to version 2.1 of the GNU Lesser General Public
  7.  * License, that is bundled with this package in the file COPYING, available
  8.  * through the world wide web at the following URI:
  9.  * http://www.gnu.org/copyleft/lesser.html.
  10.  *
  11.  * @package    ZNF
  12.  * @subpackage Presentation
  13.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  14.  * @author     Graziano Liberati <http://www.liberati.org>
  15.  * @copyright  2004-2007 The ZNF Development Team
  16.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  17.  * @version    SVN $Id: Translation.php 44 2007-07-22 23:55:30Z evolic $
  18.  * @since      Release 0.5.0
  19.  * @link       http://www.zeronotice.org
  20.  */
  21.  
  22. require_once('ZNF/Config/AppConfig.php');
  23.  
  24. /**
  25.  * <i>ZNF_Presentation_Translation</i> class handles the translations. Returns translated strings by a numeric index.
  26.  *
  27.  * You can specify if the \texttt{ZNF_Presentation_Translation} should load
  28.  * translations of a specific package or the global ones, typically used in the
  29.  * whole application. The first parameter of the constructor of
  30.  * \texttt{ZNF_Presentation_Translation} let you to specify the package to use.
  31.  * If you pass a string to this parameter the
  32.  * \texttt{ZNF_Presentation_Translation} object will load translations files
  33.  * from the ``lang'' directory of the specified package. If no string is passed
  34.  * to this parameter the \texttt{ZNF_Presentation_Translation} object will load
  35.  * translations files from the ``lang'' directory of the root of the application.
  36.  *
  37.  * @access     public
  38.  * @package    ZNF
  39.  * @subpackage Presentation
  40.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  41.  * @author     Graziano Liberati <http://www.liberati.org>
  42.  * @copyright  2004-2007 The ZNF Development Team
  43.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  44.  * @version    SVN $Id: Translation.php 44 2007-07-22 23:55:30Z evolic $
  45.  * @since      Release 0.5.0
  46.  * @link       http://www.zeronotice.org
  47.  */
  48. class ZNF_Presentation_Translation
  49. {
  50.  
  51.     /**
  52.      * The <i>ZNF_Config_AppConfig</i> instance.
  53.      *
  54.      * @access protected
  55.      * @var ZNF_Config_AppConfig $_appConfig 
  56.      */
  57.     protected $_appConfig;
  58.  
  59.     /**
  60.      * The array of the translation.
  61.      *
  62.      * @access protected
  63.      * @var array $_translation 
  64.      */
  65.     protected $_translation;
  66.  
  67.     /**
  68.      * Constructs a new <i>ZNF_Presentation_Translation</i> object.
  69.      *
  70.      * @access public
  71.      * @param string $package Name of the package to which the lang refers, leave
  72.      *                         null this parameter to refer to the application lang
  73.      *                         path
  74.      * @param string $lang Name of the language to get (en, it, etc.), leave null
  75.      *                      this parameter to refer to the default application lang
  76.      */
  77.     public function __construct($package = null, $lang = null)
  78.     {
  79.         $this->_appConfig = ZNF_Config_AppConfig::getInstance();
  80.         $this->_parseLang($package, $lang);
  81.     }
  82.  
  83.     /**
  84.      * Parses and validates the translation files.
  85.      *
  86.      * For performance reasons implements a caching mechanism that serializes the
  87.      * translations file in an internal structure.
  88.      *
  89.      * @access protected
  90.      * @param string $package Name of the package to which the lang refers, leave
  91.      *                         null this parameter to refer to the application lang
  92.      *                         path
  93.      * @param string $lang Name of the language to get (en, it, etc.), leave null
  94.      *                      this parameter to refer to the default application lang
  95.      */
  96.     protected function _parseLang($package = null, $lang = null)
  97.     {
  98.         $path = $this->_getLangPath($package, $lang);
  99.         $xmlTimestamp = filemtime($path);
  100.         $serializedTimestamp = @filemtime(ZNF::CACHE_DIR . "/{$package}_lang_{$lang}.xml.cache");
  101.  
  102.         // check the timestamp
  103.         if ($xmlTimestamp <= $serializedTimestamp) {
  104.             $this->_translation = unserialize(file_get_contents(ZNF::CACHE_DIR . "/{$package}_lang_{$lang}.xml.cache"));
  105.         } else {
  106.             // get and validate the default language xml document
  107.             $defaultPath = $this->_getLangPath($package, $this->_appConfig->getLang());
  108.             $translationDefaultXml = DOMDocument::load($defaultPath);
  109.  
  110.             // quick hack to make ZNF work as a PEAR package, to be improved
  111.             $dirName = dirname(__FILE__);
  112.             $schemaPath = substr($dirName, 0, strpos($dirName, 'Presentation')) . "xsd/znf-translation.xsd";
  113.             if (!$translationDefaultXml->schemaValidate($schemaPath)) {
  114.                 $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  115.                 throw new ZNF_Action_RequestProcessorException($translation->get('errorLoadTranslation'));
  116.             }
  117.  
  118.             $translationDefaultXpath = new DOMXPath($translationDefaultXml);
  119.             $translationDefaultXpath->registerNamespace('tra', 'http://www.zeronotice.org/ZNF/znf-translation');
  120.  
  121.             // get the default language items
  122.             $defaultItems = $translationDefaultXpath->query('/tra:znf-translation/tra:item');
  123.  
  124.             // get and validate the language xml document
  125.             $translationXml = DOMDocument::load($path);
  126.  
  127.             if (!$translationXml->schemaValidate($schemaPath)) {
  128.                 $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  129.                 throw new ZNF_Action_RequestProcessorException($translation->get('errorLoadTranslation'));
  130.             }
  131.  
  132.             $translationXpath = new DOMXPath($translationXml);
  133.             $translationXpath->registerNamespace('tra', 'http://www.zeronotice.org/ZNF/znf-translation');
  134.             $translation = array();
  135.  
  136.             // build the translation array completing with default translation
  137.             foreach ($defaultItems as $current) {
  138.                 $code = $current->getAttribute('code');
  139.                 $item = $translationXpath->query('/tra:znf-translation/tra:item[@code="' . $code . '"]');
  140.  
  141.                 if ($item->length) {
  142.                     $translation[$code] = $item->item(0)->getAttribute('text');
  143.                 } else {
  144.                     $translation[$code] = $current->getAttribute('text');
  145.                 }
  146.  
  147.             }
  148.  
  149.             file_put_contents(ZNF::CACHE_DIR . "/{$package}_lang_{$lang}.xml.cache", serialize($translation));
  150.             $this->_translation = $translation;
  151.         }
  152.     }
  153.  
  154.     /**
  155.      * Returns the path of a language file.
  156.      *
  157.      * @access protected
  158.      * @param string $package Name of the package to which the lang refers, leave
  159.      *                         null this parameter to refer to the application lang
  160.      *                         path
  161.      * @param string $lang Name of the language to get (en, it, etc.), leave null
  162.      *                      this parameter to refer to the default application lang
  163.      * @return string 
  164.      */
  165.     protected function _getLangPath($package = null, $lang = null)
  166.     {
  167.         $path = null;
  168.  
  169.         // quick hack to make ZNF work as a PEAR package, to be improved
  170.         if ($package == 'ZNF') {
  171.             $dirName = dirname(__FILE__);
  172.             $path = substr($dirName, 0, strpos($dirName, 'Presentation'));
  173.         } elseif ($package) {
  174.             $path =  ZNF::MODULES_DIR . "/$package/";
  175.         }
  176.  
  177.         if ($lang) {
  178.             $pathLang = $path . ZNF::LANG_DIR . "/{$lang}.xml";
  179.  
  180.             if (is_file($pathLang)) {
  181.                 return $pathLang;
  182.             }
  183.  
  184.         }
  185.  
  186.         $pathDefault = $path . ZNF::LANG_DIR . "/{$this->_appConfig->getLang()}.xml";
  187.  
  188.         if (!is_file($pathDefault)) {
  189.             // not translated to avoid code looping
  190.             throw new ZNF_Presentation_TranslationException('Error loading default language.');
  191.         }
  192.  
  193.         return $pathDefault;
  194.     }
  195.  
  196.     /**
  197.      * Returns the translated message.
  198.      *
  199.      * @access public
  200.      * @param string $code Id of the string to translate
  201.      * @return string 
  202.      */
  203.     public function get($code)
  204.     {
  205.         if (isset($this->_translation[$code])) {
  206.             return $this->_translation[$code];
  207.         } else {
  208.             return null;
  209.         }
  210.     }
  211.  
  212.     /**
  213.      * Destroys the <i>ZNF_Presentation_Translation</i> object.</>
  214.      *
  215.      * @access public
  216.      */
  217.     public function __destruct()
  218.     {
  219.     }
  220.  
  221. }
  222.  
  223. /**
  224.  * <i>ZNF_Presentation_TranslationException</i> is the exception type for the <i>ZNF_Presentation_Translation</i> class.
  225.  *
  226.  * <i>ZNF_Presentation_TranslationException</i> extends the <i>Exception</i> class of PHP5.
  227.  *
  228.  * @access     public
  229.  * @package    ZNF
  230.  * @subpackage Presentation
  231.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  232.  * @author     Graziano Liberati <http://www.liberati.org>
  233.  * @copyright  2004-2007 The ZNF Development Team
  234.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  235.  * @version    SVN $Id: Translation.php 44 2007-07-22 23:55:30Z evolic $
  236.  * @since      Release 0.5.0
  237.  * @link       http://www.zeronotice.org
  238.  */
  239. class ZNF_Presentation_TranslationException extends Exception
  240. {
  241. }
  242.  
  243. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:41 +0100 by phpDocumentor 1.4.0