Added visibility information to all the functions
[isso.git] / date.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 /**
23 * Date formatting system
24 * date.php
25 *
26 * @package ISSO
27 */
28
29 /**
30 * Defined constant time
31 */
32 define('TIMENOW', time());
33
34 /**
35 * Date Formatting System
36 *
37 * This framework handles the complexities of date and time formatting
38 * by taking variables like global timezone and user timezone, then
39 * adjusting timestamps accordingly.
40 *
41 * @author Iris Studios, Inc.
42 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
43 * @version $Revision$
44 * @package ISSO
45 *
46 */
47 class Date
48 {
49 /**
50 * Framework registry object
51 * @var object
52 */
53 var $registry = null;
54
55 /**
56 * User timezone offset
57 * @var integer
58 */
59 var $usertz = 0;
60
61 /**
62 * Server's timezone offset; this is set using fetch_offset()
63 * @var integer
64 */
65 var $servertz = 0;
66
67 /**
68 * Total offset timezone; this is set using fetch_offset()
69 * @var integer
70 */
71 var $offsettz = 0;
72
73 /**
74 * Offset in seconds; this is set using fetch_offset()
75 * @var integer
76 */
77 var $offset = 0;
78
79 /**
80 * Constructor: sets the server's timezone
81 */
82 function __construct(&$registry)
83 {
84 $this->registry =& $registry;
85
86 $this->servertz = date('Z', TIMENOW) / 3600;
87 }
88
89 /**
90 * (PHP 4) Constructor
91 */
92 function Date(&$registry)
93 {
94 $this->__construct($registry);
95 }
96
97 /**
98 * Computes the total offset, taking into account all
99 * the various options
100 *
101 * @access public
102 */
103 function fetch_offset()
104 {
105 $this->offsettz = $this->servertz - $this->usertz;
106 $this->offset = $this->offsettz * 3600;
107 }
108
109 /**
110 * Formats a UNIX timestamp to a certain date format in the proper time zone
111 *
112 * @access public
113 *
114 * @param string Format of the date (same as PHP's date() function)
115 * @param integer UNIX timestamp to format
116 * @param bool Adjust the date to the user's language?
117 *
118 * @return string Formatted date
119 */
120 function format($format, $timestamp = TIMENOW, $adjust = true)
121 {
122 if ($adjust)
123 {
124 $timestamp -= $this->offset;
125 }
126
127 return date($format, $timestamp);
128 }
129
130 /**
131 * Fetches an array of timezones for a <select> list
132 *
133 * @access public
134 *
135 * @return array List of timezones
136 */
137 function fetch_timezone_list()
138 {
139 $opt = array();
140
141 $opt['-12'] = '(GMT - 12:00) Enitwetok, Kwajalien';
142 $opt['-11'] = '(GMT - 11:00) Midway Island, Samoa';
143 $opt['-10'] = '(GMT - 10:00) Hawaii';
144 $opt['-9'] = '(GMT - 9:00) Alaska';
145 $opt['-8'] = '(GMT - 8:00) Pacific Time (US &amp; Canada)';
146 $opt['-7'] = '(GMT - 7:00) Mountain Time (US &amp; Canada)';
147 $opt['-6'] = '(GMT - 6:00) Central Time (US &amp; Canada)';
148 $opt['-5'] = '(GMT - 5:00) Eastern Time (US &amp; Canada)';
149 $opt['-4'] = '(GMT - 4:00) Atlantic Time (Canada)';
150 $opt['-3.5'] = '(GMT - 3:30) Newfoundland';
151 $opt['-3'] = '(GMT - 3:00) Brazil, Buenos Aires, Georgetown';
152 $opt['-2'] = '(GMT - 2:00) Mid-Atlantic, St. Helena';
153 $opt['-1'] = '(GMT - 1:00) Azores, Cape Verde Islands';
154 $opt['0'] = '(GMT) London, Dublin, Casablanca';
155 $opt['1'] = '(GMT + 1:00) Berlin, Madrid, Paris';
156 $opt['2'] = '(GMT + 2:00) Kaliningrad, South Africa, Warsaws';
157 $opt['3'] = '(GMT + 3:00) Baghdad, Moscow, Nairobi';
158 $opt['3.5'] = '(GMT + 3:30) Tehran';
159 $opt['4'] = '(GMT + 4:00) Abu Dhabi, Tbilisi, Muscat';
160 $opt['4.5'] = '(GMT + 4:30) Kabul';
161 $opt['5'] = '(GMT + 5:00) Ekaterinburg, Islamabad, Tashkent';
162 $opt['5.5'] = '(GMT + 5:30) Calcutta, Madras, New Delhi';
163 $opt['6'] = '(GMT + 6:00) Almaty, Colomba, Dhakra';
164 $opt['7'] = '(GMT + 7:00) Bangkok, Hanoi, Jakarta';
165 $opt['8'] = '(GMT + 8:00) Beijing, Hong Kong, Singapore';
166 $opt['9'] = '(GMT + 9:00) Seoul, Tokyo, Yakutsk';
167 $opt['9.5'] = '(GMT + 9:30) Adelaide, Darwin';
168 $opt['10'] = '(GMT + 10:00) Guam, Papua New Guinea, Sydney';
169 $opt['11'] = '(GMT + 11:00) Magadan, New Caledonia, Solomon Islands';
170 $opt['12'] = '(GMT + 12:00) Auckland, Wellington, Fiji';
171
172 return $opt;
173 }
174 }
175
176 /*=====================================================================*\
177 || ###################################################################
178 || # $HeadURL$
179 || # $Id$
180 || ###################################################################
181 \*=====================================================================*/
182 ?>