<?php
/*=====================================================================*\
|| ################################################################### ||
|| # Iris Studios Shared Object Framework [#]version[#]
|| # --------------------------------------------------------------- # ||
|| # Copyright Š2002-[#]year[#] by Iris Studios, Inc. All Rights Reserved. # ||
|| # This file may not be reproduced in any way without permission.  # ||
|| # --------------------------------------------------------------- # ||
|| # User License Agreement at http://www.iris-studios.com/license/  # ||
|| ################################################################### ||
\*=====================================================================*/

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

$OBJECT = 'Localization System';
$CLASS = 'Localize';
$OBJ = 'lang';

/**
* 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, a C tool
* 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.
*
* @author		Iris Studios, Inc.
* @copyright	Copyright Š2002 - [#]year[#], Iris Studios, Inc.
* @version		$Revision$
* @package		ISSO
* 
*/
class Localize
{
	/**
	* Localization table
	* @var	array
	*/
	var $localtable = array();
	
	/**
	* The lex lookup table
	* @var	array
	*/
	var $lextable = array();
	
	/**
	* Initializes the localization system with a table
	*
	* @param	array	Localization table
	*/
	function init_with_table($table)
	{
		$this->localtable = $table;
	}
	
	/**
	* Returns a localized string from the table
	*
	* @param	str	Text to localize
	*
	* @return	str	Localized string
	*/
	function string($key)
	{
		return $key;
	}
	
	/**
	* Returns a value from the lex table for a specific code
	*
	* @param	str	Lex code
	*
	* @return	str	Localized string
	*/
	function getlex($code)
	{
		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
	*
	* @param	str	Lex code
	* @param	str	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"] = $this->string($value);
	}
}

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