<?php
/*=====================================================================*\
|| ###################################################################
|| # Iris Studios Shared Object Framework [#]issoversion[#]
|| # Copyright Š2002-[#]year[#] Iris Studios, Inc.
|| #
|| # This program is free software; you can redistribute it and/or modify
|| # it under the terms of the GNU General Public License as published by
|| # the Free Software Foundation; version [#]gpl[#] of the License.
|| #
|| # This program is distributed in the hope that it will be useful, but
|| # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|| # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|| # more details.
|| #
|| # You should have received a copy of the GNU General Public License along
|| # with this program; if not, write to the Free Software Foundation, Inc.,
|| # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|| ###################################################################
\*=====================================================================*/

/**
* Localization system
* localize.php
*
* @package	ISSO
*/

/**
* Localization System
*
* This framework handles localization. Localization in new ISSO
* applications is done through this framework. Nearly all strings
* are passed to the string function, which looks up the string in
* a .strings.xml file during runtime. Before release, mkstrings
* creates the .strings.xml file for translators. Common strings
* can be accessed through the get lex function which calls a string
* based on unique identifier; this is useful for commonly used strings.
*
* Constants:
*		ISSO_LOCALIZE_DEBUG - Wrap all strings in markup to show that it
*								has been localized
*
* @author		Iris Studios, Inc.
* @copyright	Copyright Š2002 - [#]year[#], Iris Studios, Inc.
* @version		$Revision$
* @package		ISSO
* 
*/
class Localize
{
	/**
	* Framework registry object
	* @var	object
	* @access	private
	*/
	var $registry = null;
	
	/**
	* Localization table
	* @var	array
	* @access	private
	*/
	var $localtable = array();
	
	/**
	* The lex lookup table
	* @var	array
	* @access	private
	*/
	var $lextable = array();
	
	// ###################################################################
	/**
	* Constructor
	*/
	function __construct(&$registry)
	{
		$this->registry =& $registry;
	}
	
	// ###################################################################
	/**
	* (PHP 4) Constructor
	*/
	function Localize(&$registry)
	{
		$this->__construct($registry);
	}
	
	// ###################################################################
	/**
	* Initializes the localization system with a table
	*
	* @access	public
	*
	* @param	array	Localization table
	*/
	function init_with_table($table)
	{
		$this->localtable = $table;
	}
	
	// ###################################################################
	/**
	* Returns a localized string from the table
	*
	* @access	public
	*
	* @param	string	Text to localize
	*
	* @return	string	Localized string
	*/
	function string($key)
	{
		if (defined('ISSO_LOCALIZE_DEBUG'))
		{
			return '[@&quot;' . $key . '&quot;]';
		}
		
		if (isset($this->localtable["$key"]))
		{
			return $this->localtable["$key"];
		}
		
		return $key;
	}
	
	// ###################################################################
	/**
	* Returns a value from the lex table for a specific code
	*
	* @access	public
	*
	* @param	string	Lex code
	*
	* @return	string	Localized string
	*/
	function getlex($code)
	{
		if (defined('ISSO_LOCALIZE_DEBUG'))
		{
			return '&[@&quot;' . $code . '&quot;]';
		}
		
		if (isset($this->lextable["$code"]))
		{
			return $this->lextable["$code"];
		}
		
		trigger_error('Lex code `' . $code . '` did not appear in the lex table', E_USER_ERROR);
	}
	
	// ###################################################################
	/**
	* Sets a value in the lex table for easy access of strings
	* that are commonly used
	*
	* @access	public
	*
	* @param	string	Lex code
	* @param	string	Text equiv
	*/
	function setlex($code, $value)
	{
		if (isset($this->lextable["$code"]))
		{
			trigger_error('Cannot set lex `' . $code . '` : value already exists', E_USER_ERROR);
		}
		
		$this->lextable["$code"] = $value;
	}
}

/*=====================================================================*\
|| ###################################################################
|| # $HeadURL$
|| # $Id$
|| ###################################################################
\*=====================================================================*/
?>