update for version 1.0.1

code/vendor/giggsey/libphonenumber-for-php/src/libphonenumber/PhoneNumberToTimeZonesMapper.php

@@ -0,0 +1,159 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: giggsey
+ * Date: 14/10/13
+ * Time: 16:00
+ */
+
+namespace libphonenumber;
+
+use libphonenumber\prefixmapper\PrefixTimeZonesMap;
+
+class PhoneNumberToTimeZonesMapper
+{
+    const UNKNOWN_TIMEZONE = 'Etc/Unknown';
+    const MAPPING_DATA_DIRECTORY = '/timezone/data/';
+    const MAPPING_DATA_FILE_NAME = "map_data.php";
+    /**
+     * @var PhoneNumberToTimeZonesMapper
+     */
+    private static $instance = null;
+    private $unknownTimeZoneList = array();
+    /**
+     * @var PhoneNumberUtil
+     */
+    private $phoneUtil;
+    private $prefixTimeZonesMap;
+
+    private function __construct($phonePrefixDataDirectory)
+    {
+        $this->prefixTimeZonesMap = self::loadPrefixTimeZonesMapFromFile(
+            dirname(__FILE__) . $phonePrefixDataDirectory . DIRECTORY_SEPARATOR . self::MAPPING_DATA_FILE_NAME
+        );
+        $this->phoneUtil = PhoneNumberUtil::getInstance();
+
+        $this->unknownTimeZoneList[] = self::UNKNOWN_TIMEZONE;
+    }
+
+    private static function loadPrefixTimeZonesMapFromFile($path)
+    {
+        if (!is_readable($path)) {
+            throw new \InvalidArgumentException("Mapping file can not be found");
+        }
+
+        $data = require $path;
+
+        $map = new PrefixTimeZonesMap($data);
+
+        return $map;
+    }
+
+    /**
+     * Gets a {@link PhoneNumberToTimeZonesMapper} instance.
+     *
+     * <p> The {@link PhoneNumberToTimeZonesMapper} is implemented as a singleton. Therefore, calling
+     * this method multiple times will only result in one instance being created.
+     *
+     * @param $mappingDir
+     * @return PhoneNumberToTimeZonesMapper instance
+     */
+    public static function getInstance($mappingDir = self::MAPPING_DATA_DIRECTORY)
+    {
+        if (self::$instance === null) {
+            self::$instance = new self($mappingDir);
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Returns a String with the ICU unknown time zone.
+     * @return string
+     */
+    public static function getUnknownTimeZone()
+    {
+        return self::UNKNOWN_TIMEZONE;
+    }
+
+    /**
+     * As per {@link #getTimeZonesForGeographicalNumber(PhoneNumber)} but explicitly checks
+     * the validity of the number passed in.
+     *
+     * @param $number PhoneNumber the phone number for which we want to get the time zones to which it belongs
+     * @return array a list of the corresponding time zones or a single element list with the default
+     *     unknown time zone if no other time zone was found or if the number was invalid
+     */
+    public function getTimeZonesForNumber(PhoneNumber $number)
+    {
+        $numberType = $this->phoneUtil->getNumberType($number);
+
+        if ($numberType === PhoneNumberType::UNKNOWN) {
+            return $this->unknownTimeZoneList;
+        } elseif (!$this->canBeGeocoded($numberType)) {
+            return $this->getCountryLevelTimeZonesforNumber($number);
+        }
+
+        return $this->getTimeZonesForGeographicalNumber($number);
+    }
+
+    /**
+     * A similar method is implemented as PhoneNumberUtil.isNumberGeographical, which performs a
+     * stricter check, as it determines if a number has a geographical association. Also, if new
+     * phone number types were added, we should check if this other method should be updated too.
+     * TODO: Remove duplication by completing the logic in the method in PhoneNumberUtil.
+     *                   For more information, see the comments in that method.
+     * @param $numberType
+     * @return bool
+     */
+    public function canBeGeocoded($numberType)
+    {
+        return ($numberType === PhoneNumberType::FIXED_LINE ||
+            $numberType === PhoneNumberType::MOBILE ||
+            $numberType === PhoneNumberType::FIXED_LINE_OR_MOBILE
+        );
+    }
+
+    /**
+     * Returns the list of time zones corresponding to the country calling code of {@code number}.
+     *
+     * @param $number PhoneNumber the phone number to look up
+     * @return array the list of corresponding time zones or a single element list with the default
+     *     unknown time zone if no other time zone was found
+     */
+    private function getCountryLevelTimeZonesforNumber(PhoneNumber $number)
+    {
+        $timezones = $this->prefixTimeZonesMap->lookupCountryLevelTimeZonesForNumber($number);
+        return (count($timezones) == 0) ? $this->unknownTimeZoneList : $timezones;
+    }
+
+    /**
+     * Returns a list of time zones to which a phone number belongs.
+     *
+     * <p>This method assumes the validity of the number passed in has already been checked, and that
+     * the number is geo-localizable. We consider fixed-line and mobile numbers possible candidates
+     * for geo-localization.
+     *
+     * @param $number PhoneNumber a valid phone number for which we want to get the time zones to which it belongs
+     * @return array a list of the corresponding time zones or a single element list with the default
+     *     unknown time zone if no other time zone was found or if the number was invalid
+     */
+    public function getTimeZonesForGeographicalNumber(PhoneNumber $number)
+    {
+        return $this->getTimeZonesForGeocodableNumber($number);
+    }
+
+    /**
+     * Returns a list of time zones to which a geocodable phone number belongs.
+     *
+     * @param PhoneNumber $number The phone number for which we want to get the time zones to which it belongs
+     * @return array the list of correspondiing time zones or a single element list with the default
+     * unknown timezone if no other time zone was found or if the number was invalid
+     */
+    private function getTimeZonesForGeocodableNumber(PhoneNumber $number)
+    {
+        $timezones = $this->prefixTimeZonesMap->lookupTimeZonesForNumber($number);
+        return (count($timezones) == 0) ? $this->unknownTimeZoneList : $timezones;
+    }
+
+}