Geeklog: system/classes/timezoneconfig.class.php@a053d9023368

     1 <?php

     3 /* Reminder: always indent with 4 spaces (no tabs). */

     4 // +---------------------------------------------------------------------------+

     5 // | Geeklog 1.6                                                               |

     6 // +---------------------------------------------------------------------------+

     7 // | timezoneconfig.class.php                                                  |

     8 // |                                                                           |

     9 // | Helper class for time zone handling                                       |

    10 // +---------------------------------------------------------------------------+

    11 // | Copyright (C) 2009 by the following authors:                              |

    12 // |                                                                           |

    13 // | Authors: Dirk Haun             - dirk AT haun-online DOT de               |

    14 // | based on earlier work by Oliver Spiesshofer, Yew Loong, and others        |

    15 // +---------------------------------------------------------------------------+

    16 // |                                                                           |

    17 // | This program is free software; you can redistribute it and/or             |

    18 // | modify it under the terms of the GNU General Public License               |

    19 // | as published by the Free Software Foundation; either version 2            |

    20 // | of the License, or (at your option) any later version.                    |

    21 // |                                                                           |

    22 // | This program is distributed in the hope that it will be useful,           |

    23 // | but WITHOUT ANY WARRANTY; without even the implied warranty of            |

    24 // | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             |

    25 // | GNU General Public License for more details.                              |

    26 // |                                                                           |

    27 // | You should have received a copy of the GNU General Public License         |

    28 // | along with this program; if not, write to the Free Software Foundation,   |

    29 // | Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.           |

    30 // |                                                                           |

    31 // +---------------------------------------------------------------------------+

    33 /**

    34 * Geeklog Time Zone Config class

    35 *

    36 * A collection of static (for now) methods dealing with time zone handling.

    37 *

    38 * For the original "Timezone Hack" discussion, see

    39 * @link http://www.geeklog.net/forum/viewtopic.php?showtopic=21232

    40 *

    41 * @author Dirk Haun, dirk AT haun-online DOT de

    42 *

    43 */

    44 class TimeZoneConfig {

    46     /**

    47     * Set the system's timezone

    48     *

    49     * @param    string  $tz     timezone to set; use $_CONF['timezone'] if empty

    50     * @return   void

    51     * @static

    52     *

    53     */

    54     function setSystemTimeZone($tz = '')

    55     {

    56         global $_CONF;

    58         if (empty($tz) && !empty($_CONF['timezone'])) {

    59             $tz = $_CONF['timezone'];

    60         }

    62         if (! empty($tz)) {

    63             if (function_exists('date_default_timezone_set')) {

    64                 if (! @date_default_timezone_set($tz)) {

    65                     date_default_timezone_set('UTC');

    66                     COM_errorLog("Timezone '$tz' not valid - using 'UTC' instead", 1);

    67                 }

    68             } elseif (!ini_get('safe_mode') && function_exists('putenv')) {

    69                 // aka "Timezone Hack"

    70                 putenv('TZ=' . $tz);

    71             }

    72         } elseif (function_exists('date_default_timezone_get')) {

    73             // this is not ideal but will stop PHP 5.3.0ff from complaining ...

    74             date_default_timezone_set(@date_default_timezone_get());

    75         }

    76     }

    78     /**

    79     * Get the user's preferred timezone

    80     *

    81     * @return   string  name of the timezone

    82     * @static

    83     *

    84     */

    85     function getUserTimeZone()

    86     {

    87         global $_CONF, $_USER;

    89         // handle like the theme cookie, i.e. use if user is not logged in

    90         if (isset($_COOKIE[$_CONF['cookie_tzid']]) && empty($_USER['tzid'])) {

    91             $_USER['tzid'] = $_COOKIE[$_CONF['cookie_tzid']];

    92         }

    94         if (! empty($_USER['tzid'])) {

    95             $timezone = $_USER['tzid'];

    96         } elseif (! empty($_CONF['timezone'])) {

    97             $timezone = $_CONF['timezone'];

    98         } elseif (function_exists('date_default_timezone_get')) {

    99             $timezone = @date_default_timezone_get();

   100         } else {

   101             require_once 'Date/TimeZone.php';

   103             $tz_obj = Date_TimeZone::getDefault();

   104             $timezone = $tz_obj->id;

   105         }

   107         return $timezone;

   108     }

   110     /**

   111     * Provide a dropdown menu of the available timezones

   112     *

   113     * @return   string  HTML for the dropdown

   114     * @static

   115     *

   116     */

   117     function getTimeZoneDropDown($selected = '', $attributes = array())

   118     {

   119         $timezones = TimeZoneConfig::listAvailableTimeZones();

   121         $selection = '<select';

   122         foreach ($attributes as $name => $value) {

   123             $selection .= sprintf(' %s="%s"', $name, $value);

   124         }

   125         $selection .= '>' . LB;

   127         foreach ($timezones as $tzid => $tzdisplay) {

   128             $selection .= '<option value="' . $tzid . '"';

   129             if (!empty($selected) && ($selected == $tzid)) {

   130                 $selection .= ' selected="selected"';

   131             }

   132             $selection .= ">$tzdisplay</option>" . LB;

   133         }

   134         $selection .= '</select>';

   136         return $selection;

   137     }

   139     /**

   140     * Provide a list of available timezones

   141     *

   142     * @return   array   array of (timezone-short-name, timezone-long-name) pairs

   143     * @static

   144     *

   145     */

   146     function listAvailableTimeZones()

   147     {

   148         $timezones = array();

   150         // use only timezones that contain one of these

   151         $useonly = array('Africa', 'America', 'Antarctica', 'Arctic', 'Asia',

   152                          'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific',

   153                          'UTC');

   155         // check if we can use the DateTimeZone class

   156         $useDateTimeZone = false;

   157         if (class_exists('DateTimeZone') && class_exists('ReflectionClass')) {

   158             $rc = new ReflectionClass('DateTimeZone');

   159             if ($rc->hasMethod('listAbbreviations')) {

   160                 $useDateTimeZone = true;

   161             }

   162         }

   164         if ($useDateTimeZone) {

   166             $T = DateTimeZone::listAbbreviations();

   167             foreach ($T as $tzid => $entries) {

   168                 $shortname = strtoupper($tzid);

   169                 foreach ($entries as $data) {

   170                     $tzcheck = explode('/', $data['timezone_id']);

   171                     if (! in_array($tzcheck[0], $useonly)) {

   172                         continue;

   173                     }

   175                     $hours = $data['offset'] / 3600;

   176                     $hours = ((int) ($hours * 100) / 100);

   177                     if ($hours > 0) {

   178                         $hours = "+$hours";

   179                     }

   181                     $tzcode = str_replace('_', ' ', $data['timezone_id']);

   182                     $tzcode = htmlspecialchars($tzcode);

   183                     $formattedTimezone = "$hours, $shortname ($tzcode)";

   184                     $timezones[$data['timezone_id']] = $formattedTimezone;

   185                 }

   186             }

   188         } else { // DateTimeZone not available - use PEAR Date class

   190             require_once 'Date/TimeZone.php';

   192             $T = $GLOBALS['_DATE_TIMEZONE_DATA'];

   194             foreach ($T as $tzid => $tDetails) {

   195                 $tzcheck = explode('/', $tzid);

   196                 if (! in_array($tzcheck[0], $useonly)) {

   197                     continue;

   198                 }

   199                 if (!empty($tzcheck[1]) &&

   200                         (strpos($tzcheck[1], 'Riyadh') === 0)) {

   201                     // these time zones are based on solar time and not widely

   202                     // supported - skip

   203                     continue;

   204                 }

   206                 $tzcode = str_replace('_', ' ', $tzid);

   207                 $tzcode = htmlspecialchars($tzcode);

   208                 $hours = $tDetails['offset'] / (3600 * 1000);

   209                 $hours = ((int) ($hours * 100) / 100);

   210                 if ($hours > 0) {

   211                     $hours = "+$hours";

   212                 }

   214                 $formattedTimezone = "$hours, {$tDetails['shortname']} ($tzcode)";

   215                 $timezones[$tzid] = $formattedTimezone;

   216             }

   218         }

   220         uasort($timezones, array('TimeZoneConfig', '_sort_by_timezone'));

   222         return $timezones;

   223     }

   225     /**

   226     * Helper method: Sort timezone entries

   227     *

   228     * @param    string  $tz1    first timezone

   229     * @param    string  $tz2    second timezone

   230     * @return   int             0: equal, <0: first<second, >0: first>second

   231     * @static

   232     * @access   private

   233     *

   234     */

   235     function _sort_by_timezone($tz1, $tz2)

   236     {

   237         $p1 = explode(',', $tz1);

   238         $p2 = explode(',', $tz2);

   240         // compare offsets

   241         $o1 = $p1[0];

   242         $o2 = $p2[0];

   243         if ($o1 != $o2) {

   244             return ($o1 < $o2 ? -1 : 1);

   245         }

   247         // drop offset, pop timezone name, then add it to the end again

   248         array_shift($p1);

   249         $tz1 = trim(implode(',', $p1));

   250         $p1 = explode(' ', $tz1);

   251         $x1 = array_shift($p1);

   252         $p1[] = $x1;

   253         $tz1 = implode(' ', $p1);

   255         array_shift($p2);

   256         $tz2 = trim(implode(',', $p2));

   257         $p2 = explode(' ', $tz2);

   258         $x2 = array_shift($p2);

   259         $p2[] = $x2;

   260         $tz2 = implode(' ', $p2);

   262         return strcmp($tz1, $tz2);

   263     }

   265 }

   267 ?>

author	Dirk Haun <dirk@haun-online.de>
	Sun, 20 Sep 2009 13:37:16 +0200
branch	HEAD
changeset 7430	a053d9023368
parent 7429	01f95a3e4545
child 7431	ecdf072e268e
permissions	-rw-r--r--