Transform timezone offsets into DateTimeZones

Author: cmfcmf

Cmfcmf/OpenWeatherMap/Util/City.php

@@ -44,30 +44,47 @@ class City extends Location
     public $population;
 
     /**
-     * @var int The shift in seconds from UTC
+     * @var \DateTimeZone|null The shift in seconds from UTC
      */
     public $timezone;
+
     /**
      * Create a new city object.
      *
-     * @param int    $id         The city id.
-     * @param string $name       The name of the city.
-     * @param float  $lat        The latitude of the city.
-     * @param float  $lon        The longitude of the city.
-     * @param string $country    The abbreviation of the country the city is located in
-     * @param int    $population The city's population.
-     * @param int    $timezone   The shift in seconds from UTC.
+     * @param int    $id             The city id.
+     * @param string $name           The name of the city.
+     * @param float  $lat            The latitude of the city.
+     * @param float  $lon            The longitude of the city.
+     * @param string $country        The abbreviation of the country the city is located in
+     * @param int    $population     The city's population.
+     * @param int    $timezoneOffset The shift in seconds from UTC.
      *
      * @internal
      */
-    public function __construct($id, $name = null, $lat = null, $lon = null, $country = null, $population = null, $timezone = null)
+    public function __construct($id, $name = null, $lat = null, $lon = null, $country = null, $population = null, $timezoneOffset = null)
     {
         $this->id = (int)$id;
         $this->name = isset($name) ? (string)$name : null;
         $this->country = isset($country) ? (string)$country : null;
         $this->population = isset($population) ? (int)$population : null;
-        $this->timezone = isset($timezone) ? (int)$timezone : null;
+        $this->timezone = isset($timezoneOffset) ? new \DateTimeZone(self::timezoneOffsetInSecondsToHours($timezoneOffset)) : null;
 
         parent::__construct($lat, $lon);
     }
+
+    /**
+     * @param int $offset The timezone offset in seconds from UTC.
+     * @return int        The timezone offset in +/-HH:MM form.
+     */
+    private static function timezoneOffsetInSecondsToHours($offset)
+    {
+        $minutes = floor(abs($offset) / 60) % 60;
+        $hours = floor(abs($offset) / 3600);
+
+        $result = $offset < 0 ? "-" : "+";
+        $result .= str_pad($hours, 2, "0", STR_PAD_LEFT);
+        $result .= str_pad($minutes, 2, "0", STR_PAD_LEFT);
+
+        return $result;
+    }
 }

Examples/CurrentWeather.php

@@ -145,7 +145,7 @@
 echo $lf;
 
 // Example 6: Get information about a city.
-$weather = $owm->getWeather('Paris', $units, $lang);
+$weather = $owm->getWeather('Kathmandu', $units, $lang);
 echo "$lf$lf EXAMPLE 6$lf";
 
 echo 'Id: '.$weather->city->id;
@@ -163,6 +163,9 @@
 echo 'Country: '.$weather->city->country;
 echo $lf;
 
+echo 'Timezone offset to UTC: '.$weather->city->timezone->getOffset(new DateTime("now", new DateTimeZone("UTC")))." seconds";
+echo $lf;
+
 // Example 7: Get wind information.
 echo "$lf$lf EXAMPLE 7$lf";
 

tests/Util/CityTest.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * OpenWeatherMap-PHP-API — A PHP API to parse weather data from https://OpenWeatherMap.org.
+ *
+ * @license MIT
+ *
+ * Please see the LICENSE file distributed with this source code for further
+ * information regarding copyright and licensing.
+ *
+ * Please visit the following links to read about the usage policies and the license of
+ * OpenWeatherMap data before using this library:
+ *
+ * @see https://OpenWeatherMap.org/price
+ * @see https://OpenWeatherMap.org/terms
+ * @see https://OpenWeatherMap.org/appid
+ */
+
+namespace Cmfcmf\OpenWeatherMap\Tests\Util;
+
+use Cmfcmf\OpenWeatherMap\Util\City;
+
+class CityTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider timezoneDataProvider
+     */
+    public function testTimezoneConversion($offsetString, $offsetSeconds)
+    {
+        $class = new \ReflectionClass(City::class);
+        $method = $class->getMethod("timezoneOffsetInSecondsToHours");
+        $method->setAccessible(true);
+
+        $this->assertSame($offsetString, $method->invoke(null, $offsetSeconds));
+        $offsetTimezone = new \DateTimeZone($offsetString);
+        $this->assertSame($offsetSeconds, $offsetTimezone->getOffset(new \DateTime("now", new \DateTimeZone("GMT"))));
+    }
+
+    public function timezoneDataProvider()
+    {
+        return [
+            ["+0100", 3600],
+            ["+0100", 3600],
+            ["+0030", 1800],
+            ["+0015", 900],
+            ["+0000", 0],
+            ["+0545", 20700],
+        ];
+    }
+}