<?php
/*=====================================================================*\
|| ###################################################################
|| # Iris Studios Shared Object Framework [#]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
|| ###################################################################
\*=====================================================================*/

/**
* Date formatting system
* date.php
*
* @package	ISSO
*/

$OBJECT = 'Date Formatting System';
$CLASS = 'Date_Formatter';
$OBJ = 'datef';

/**
* Defined constant time
*/
define('TIMENOW', time());

/**
* Date Formatting System
*
* This framework handles the complexities of date and time formatting
* by taking variables like global timezone and user timezone, then
* adjusting timestamps accordingly.
*
* @author		Iris Studios, Inc.
* @copyright	Copyright Š2002 - [#]year[#], Iris Studios, Inc.
* @version		$Revision$
* @package		ISSO
* 
*/
class Date_Formatter
{
	/**
	* Framework registry object
	* @var	object
	*/
	var $registry = null;
	
	/**
	* User timezone offset
	* @var	integer
	*/
	var $usertz = 0;
	
	/**
	* Server's timezone offset
	* @var	integer
	*/
	var $servertz = 0;
	
	/**
	* Total offset timezone
	* @var	integer
	*/
	var $offsettz = 0;
	
	/**
	* Offset in seconds
	* @var	integer
	*/
	var $offset = 0;
	
	/**
	* Constructor: sets the server's timezone
	*/
	function Date_Formatter(&$registry)
	{
		$this->registry =& $registry;
		
		$this->servertz = date('Z', TIMENOW) / 3600;
	}
	
	/**
	* Computes the total offset, taking into account all
	* the various options
	*/
	function fetch_offset()
	{
		$this->offsettz = $this->servertz - $this->usertz;
		$this->offset = $this->offsettz * 3600;
	}
	
	/**
	* Formats a UNIX timestamp to a certain date format in the proper time zone
	*
	* @param	string	Format of the date (same as PHP's date() function)
	* @param	integer	UNIX timestamp to format
	* @param	bool	Adjust the date to the user's language?
	*
	* @return	string	Formatted date
	*/
	function format($format, $timestamp = TIMENOW, $adjust = true)
	{
		if ($adjust)
		{
			$timestamp -= $this->offset;
		}
		
		return date($format, $timestamp);
	}
}

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