localize.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   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 * @author               Iris Studios, Inc.
  41 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  42 * @version              $Revision$
  43 * @package              ISSO
  44 *
  45 */
  46 class Localize
  47 {
  48         /**
  49         * Framework registry object
  50         * @var  object
  51         */
  52         var $registry = null;
  53
  54         /**
  55         * Localization table
  56         * @var  array
  57         */
  58         var $localtable = array();
  59
  60         /**
  61         * The lex lookup table
  62         * @var  array
  63         */
  64         var $lextable = array();
  65
  66         /**
  67         * Constructor
  68         */
  69         function __construct(&$registry)
  70         {
  71                 $this->registry =& $registry;
  72         }
  73
  74         /**
  75         * (PHP 4) Constructor
  76         */
  77         function Localize(&$registry)
  78         {
  79                 $this->__construct($registry);
  80         }
  81
  82         /**
  83         * Initializes the localization system with a table
  84         *
  85         * @access       public
  86         *
  87         * @param        array   Localization table
  88         */
  89         function init_with_table($table)
  90         {
  91                 $this->localtable = $table;
  92         }
  93
  94         /**
  95         * Returns a localized string from the table
  96         *
  97         * @access       public
  98         *
  99         * @param        string  Text to localize
 100         *
 101         * @return       string  Localized string
 102         */
 103         function string($key)
 104         {
 105                 if (defined('ISSO_LOCALIZE_DEBUG'))
 106                 {
 107                         return '[@&quot;' . $key . '&quot;]';
 108                 }
 109
 110                 if (isset($this->localtable["$key"]))
 111                 {
 112                         return $this->localtable["$key"];
 113                 }
 114
 115                 return $key;
 116         }
 117
 118         /**
 119         * Returns a value from the lex table for a specific code
 120         *
 121         * @access       public
 122         *
 123         * @param        string  Lex code
 124         *
 125         * @return       string  Localized string
 126         */
 127         function getlex($code)
 128         {
 129                 if (defined('ISSO_LOCALIZE_DEBUG'))
 130                 {
 131                         return '&[@&quot;' . $code . '&quot;]';
 132                 }
 133
 134                 if (isset($this->lextable["$code"]))
 135                 {
 136                         return $this->lextable["$code"];
 137                 }
 138
 139                 trigger_error('Lex code `' . $code . '` did not appear in the lex table', E_USER_ERROR);
 140         }
 141
 142         /**
 143         * Sets a value in the lex table for easy access of strings
 144         * that are commonly used
 145         *
 146         * @access       public
 147         *
 148         * @param        string  Lex code
 149         * @param        string  Text equiv
 150         */
 151         function setlex($code, $value)
 152         {
 153                 if (isset($this->lextable["$code"]))
 154                 {
 155                         trigger_error('Cannot set lex `' . $code . '` : value already exists', E_USER_ERROR);
 156                 }
 157
 158                 $this->lextable["$code"] = $value;
 159         }
 160 }
 161
 162 /*=====================================================================*\
 163 || ###################################################################
 164 || # $HeadURL$
 165 || # $Id$
 166 || ###################################################################
 167 \*=====================================================================*/
 168 ?>