localize.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework [#]issoversion[#]
   5 || # Copyright ©2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Localization system
  24 * localize.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 /**
  30 * Localization System
  31 *
  32 * This framework handles localization. Localization in new ISSO
  33 * applications is done through this framework. Nearly all strings
  34 * are passed to the string function, which looks up the string in
  35 * a .strings.xml file during runtime. Before release, mkstrings
  36 * creates the .strings.xml file for translators. Common strings
  37 * can be accessed through the get lex function which calls a string
  38 * based on unique identifier; this is useful for commonly used strings.
  39 *
  40 * Constants:
  41 *               ISSO_LOCALIZE_DEBUG - Wrap all strings in markup to show that it
  42 *                                                               has been localized
  43 *
  44 * @author               Blue Static
  45 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  46 * @version              $Revision$
  47 * @package              ISSO
  48 *
  49 */
  50 class Localize
  51 {
  52         /**
  53         * Framework registry object
  54         * @var  object
  55         */
  56         private $registry = null;
  57
  58         /**
  59         * Localization table
  60         * @var  array
  61         */
  62         private $localtable = array();
  63
  64         /**
  65         * The lex lookup table
  66         * @var  array
  67         */
  68         private $lextable = array();
  69
  70         // ###################################################################
  71         /**
  72         * Constructor
  73         */
  74         public function __construct(&$registry)
  75         {
  76                 $this->registry =& $registry;
  77         }
  78
  79         // ###################################################################
  80         /**
  81         * Initializes the localization system with a table
  82         *
  83         * @param        array   Localization table
  84         */
  85         public function init_with_table($table)
  86         {
  87                 $this->localtable = $table;
  88         }
  89
  90         // ###################################################################
  91         /**
  92         * Returns a localized string from the table
  93         *
  94         * @param        string  Text to localize
  95         *
  96         * @return       string  Localized string
  97         */
  98         public function string($key)
  99         {
 100                 if (defined('ISSO_LOCALIZE_DEBUG'))
 101                 {
 102                         return '[@&quot;' . $key . '&quot;]';
 103                 }
 104
 105                 if (isset($this->localtable["$key"]))
 106                 {
 107                         return $this->localtable["$key"];
 108                 }
 109
 110                 return $key;
 111         }
 112
 113         // ###################################################################
 114         /**
 115         * Returns a value from the lex table for a specific code
 116         *
 117         * @param        string  Lex code
 118         *
 119         * @return       string  Localized string
 120         */
 121         public function getlex($code)
 122         {
 123                 if (defined('ISSO_LOCALIZE_DEBUG'))
 124                 {
 125                         return '&[@&quot;' . $code . '&quot;]';
 126                 }
 127
 128                 if (isset($this->lextable["$code"]))
 129                 {
 130                         return $this->lextable["$code"];
 131                 }
 132
 133                 trigger_error('Lex code `' . $code . '` did not appear in the lex table', E_USER_ERROR);
 134         }
 135
 136         // ###################################################################
 137         /**
 138         * Sets a value in the lex table for easy access of strings
 139         * that are commonly used
 140         *
 141         * @param        string  Lex code
 142         * @param        string  Text equiv
 143         */
 144         public function setlex($code, $value)
 145         {
 146                 if (isset($this->lextable["$code"]))
 147                 {
 148                         trigger_error('Cannot set lex `' . $code . '` : value already exists', E_USER_ERROR);
 149                 }
 150
 151                 $this->lextable["$code"] = $value;
 152         }
 153 }
 154
 155 /*=====================================================================*\
 156 || ###################################################################
 157 || # $HeadURL$
 158 || # $Id$
 159 || ###################################################################
 160 \*=====================================================================*/
 161 ?>