File: TimeZone.inc.php

package info (click to toggle)
zoph 1.0.1-3
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 16,480 kB
  • sloc: php: 27,195; javascript: 10,374; sql: 416; sh: 152; makefile: 4
file content (149 lines) | stat: -rw-r--r-- 4,641 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<?php
/**
 * TimeZone class, extension of the standard PHP DateTimeZone class
 * Adds several Zoph-specific timezone-related functions.
 *
 * This file is part of Zoph.
 *
 * Zoph 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Zoph 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 Zoph; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @author Jeroen Roos
 * @package Zoph
 */

use conf\conf;
use template\template;

/**
 * TimeZone class, extension of the standard PHP DateTimeZone class
 *
 * @author Jeroen Roos
 * @package Zoph
 */
class TimeZone extends DateTimeZone {
    /**
     * Get an XML document describing all the known timezones
     * used to create autocomplete dropdowns
     * @param string Partial timezone name to filter timezones
     * @return string XML document
     */
    public static function getXML($search) {
        $xml = new DOMDocument('1.0','UTF-8');
        $rootnode=$xml->createElement("zones");

        $zones=static::listIdentifiers();
        array_unshift($zones, "&nbsp;");
        $len=strlen($search);
        foreach ($zones as $id => $tz) {
            $tzshort=strtolower(substr($tz,0,$len));
            if (strtolower($search)==$tzshort) {
                $newchild=$xml->createElement("tz");
                $key=$xml->createElement("key");
                $title=$xml->createElement("title");
                $key->appendChild($xml->createTextNode($id));
                $title->appendChild($xml->createTextNode($tz));
                $newchild->appendChild($key);
                $newchild->appendChild($title);

                $rootnode->appendChild($newchild);
            }
        }
        $xml->appendChild($rootnode);
        return $xml;
    }

    /**
     * Get array to build html select box
     * @return array zones
     */
    public static function getSelectArray() {
        $zones=static::listIdentifiers();
        array_unshift($zones, "");
        return $zones;
    }

    /**
     * Get array of timezones with timezone names as key
     * @return array zones with names as key
     */
    public static function getTzArray() {
        $zones=static::getSelectArray();
        $zones=array_values($zones);
        $zones=array_combine($zones, $zones);
        return $zones;
    }

    /**
     * Get Key from timezone name
     * @param string timezone
     * @return string key
     */
    public static function getKey($tz) {
        return array_search($tz,static::getSelectArray());
    }

    /**
     * Create Dropdown menu for timezone selection
     * @param string name for the html document
     * @param string current value
     * @return \template\block dropdown
     */
    public static function createDropdown($name, $value=null) {
        return template::createDropdown("timezone_id", static::getKey($value),
            static::getSelectArray());
    }

    /**
     * Validate a timezone name
     * @param string Timezone name
     * @return bool
     */
    public static function validate($tz) {
        // Checks if $tz contains a valid timezone string
        $tzones=static::listIdentifiers();
        return array_search($tz, $tzones);
    }

    /**
     * Guess timezone based on lat & lon
     * Uses the geonames project
     * @param float latitude
     * @param float longitude
     * @return string timezone
     */
    public static function guess($lat, $lon) {
        if (class_exists("XMLReader")) {
            $failed=false;
            $xml=new XMLReader();
            @$xml->open("http://api.geonames.org/timezone?username=zoph&lat=" .
                $lat . "&lng=" . $lon) or $failed=true;

            if (!$failed) {
                while ($xml->read()) {
                    if ($xml->name=="timezoneId") {
                        $xml->read();
                        return $xml->value;
                    }
                }
            } else {
                $error=error_get_last();
                log::msg("Could not connect to Geonames site: " .
                    $error["message"], log::ERROR, log::GENERAL);
            }
            return null;
        }
    }
}

?>