<?php
/*=====================================================================*\
|| ###################################################################
|| # Bugdar [#]version[#]
|| # 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
|| ###################################################################
\*=====================================================================*/

/**
* API Error Handler
*
* This class is used to catch different kinds of API errors and throw the
* appropriate front-size error depending on the context. Unlike normal
* handlers, this class can be both instantiated and used statically: check
* the method documentation for more information.
*
* @author		Iris Studios, Inc.
* @copyright	Copyright Š2002 - [#]year[#], Iris Studios, Inc.
* @version		$Revision$
* @package		Bugdar
* 
*/
class API_Error_Handler
{
	/**
	* Instance of a user-end message reporting object
	* @var	object
	* @access	private
	*/
	var $message = null;
	
	// ###################################################################
	/**
	* Constructor: set the message reporter object
	*
	* @access	public
	*
	* @param	object	Message reporting object
	*/
	function API_Error_Handler(&$mobj)
	{
		$this->message =& $mobj;
	}
	
	// ###################################################################
	/**
	* The user-end cumulative reporter requires that the class be
	* instantiated. This collects messages in the set message reporting
	* object, but never throws the error. It is the caller's responsibility
	* to check for the presence of errors and to throw the front-end
	* warning using the message object.
	*
	* @access	public
	*
	* @param	string	Error message
	*/
	function user_cumulative($error)
	{
		$this->message->add_error($error);
	}
}

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