<?php
/*=====================================================================*\
|| ###################################################################
|| # Blue Static ISSO Framework [#]issoversion[#]
|| # Copyright Š2002-[#]year[#] Blue Static
|| #
|| # 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
|| ###################################################################
\*=====================================================================*/

/**
* ISSO Registry (Register.php)
*
* @package	ISSO
*/

// TODO - rename
require_once('ISSO/Functions2.php');

/**
* Register Class
*
* This is an ISSO registry class. It holds all of the ISSO system variables as well
* as serving as an object registry that is avaliable in the global scope to prevent
* globalization of variables.
*
* @author		Blue Static
* @copyright	Copyright Š2002 - [#]year[#], Blue Static
* @version		$Revision$
* @package		ISSO
* 
*/
class BSRegister
{
	/**
	* Application name
	* @var	string
	*/
	private $application = 'Unknown ISSO Project';
	
	/**
	* Application path
	* @var	string
	*/
	private $appPath;
	
	/**
	* Application version
	* @var	string
	*/
	private $appVersion;
	
	/**
	* Web path
	* @var	string
	*/
	private $webPath;
	
	/**
	* Debug mode?
	* @var	bool
	*/
	private $debug = false;
	
	/**
	* The master registry list
	* @var	array
	*/
	private $registry = array();
	
	// ###################################################################
	/**
	* Sets the application name
	*
	* @param	string	Application name
	*/
	public function setApplication($name)
	{
		$this->application = $name;
	}
	
	// ###################################################################
	/**
	* Gets the application name
	*
	* @return	string	Application name
	*/
	public function getApplication()
	{
		return $this->application;
	}
	
	// ###################################################################
	/**
	* Sets the application's working path
	*
	* @param	string	Path
	*/
	public function setAppPath($path)
	{
		$this->appPath = BSFunctions::FetchSourcePath($path);
	}
	
	// ###################################################################
	/**
	* Returns the path to the application
	*
	* @return	string	Application path
	*/
	public function getAppPath()
	{
		return $this->appPath;
	}
	
	// ###################################################################
	/**
	* Sets the application version
	*
	* @param	string	Application version
	*/
	public function setAppVersion($vers)
	{
		$this->appVersion = $vers;
	}
	
	// ###################################################################
	/**
	* Gets the application version
	*
	* @return	string	Application version
	*/
	public function getAppVersion()
	{
		return $this->appVersion;
	}
	
	// ###################################################################
	/**
	* Sets the application's web path, which is the full path from the
	* server's web root
	*
	* @param	string	Path
	*/
	public function setWebPath($path)
	{
		$this->webPath = BSFunctions::FetchSourcePath($path);
	}
	
	// ###################################################################
	/**
	* Returns the web path to the application
	*
	* @return	string	Application's web path
	*/
	public function getWebPath()
	{
		return $this->webPath;
	}
	
	// ###################################################################
	/**
	* Sets the debug state
	*
	* @param	bool	Debug mode on?
	*/
	public function setDebug($debug)
	{
		$this->debug = $debug;
	}
	
	// ###################################################################
	/**
	* Gets the debug mode state
	*
	* @return	bool	Debug mode on?
	*/
	public function getDebug()
	{
		return $this->debug;
	}
	
	// ###################################################################
	/**
	* Registers a value in the master registry. You cannot overwrite
	* values. You must first unregister() them if you wish to do so.
	*
	* @param	string	Registry key
	* @param	mixed	Value to register
	*/
	public function register($key, $value)
	{
		if (isset($this->registry["$key"]))
		{
			trigger_error('Cannot overwrite a key in the registry');
			return;
		}
		
		$this->registry["$key"] = $value;
	}
	
	// ###################################################################
	/**
	* Unregisters a value from the registry. This removes all traces of
	* it from this object.
	*
	* @param	string	Registry key
	*/
	public function unregister($key)
	{
		if (!isset($this->registry["$key"]))
		{
			trigger_error('You cannot unregister a key that does not exist');
			return;
		}
		
		unset($this->registry["$key"]);
	}
	
	// ###################################################################
	/**
	* This gets a value from the registry with a specific key
	*
	* @param	string	The key
	*
	* @return	mixed	Value in the registry for key
	*/
	public function get($key)
	{
		if (!isset($this->registry["$key"]))
		{
			trigger_error('Cannot access the registry with a non-existent key');
			return;
		}
		
		return $this->registry["$key"];
	}
	
	// ###################################################################
	/**
	* Returns the entire registry stack
	*
	* @return	array	Complete registry
	*/
	public function getAll()
	{
		return $this->registry;
	}
}

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