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 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie;
/**
* Representation of a time zone location.
*
* <pre>
* <?php
*
* use ICanBoogie\TimeZoneLocation;
*
* $zone = new \DateTimeZone('Europe/Paris');
* $location = new TimeZoneLocation($zone->getLocation());
*
* echo $location; // FR,48.86667,2.33333
* echo $location->country_code; // FR
* echo $location->latitude; // 48.86667
* echo $location->longitude; // 2.33333
*
* $location->latitude = true; // throws ICanBoogie\PropertyNotWritable
* </pre>
*
* @property-read string $country_code The country code of the location.
* @property-read float $latitude The latitude of the location.
* @property-read float $longitude The longitude of the location.
* @property-read string $comments Comments on the location.
*/
class TimeZoneLocation
{
static private $cache;
/**
* Creates an instance from a {@link \DateTimeZone} instance.
*
* @param \DateTimeZone $zone
*
* @return \ICanBoogie\TimeZoneLocation
*/
static public function from(\DateTimeZone $zone)
{
$hash = spl_object_hash($zone);
if (empty(self::$cache[$hash]))
{
self::$cache[$hash] = new static($zone->getLocation());
}
return self::$cache[$hash];
}
private $location;
/**
* Initializes the {@link $location} property.
*
* @param array $location Location information provided by {@link \DateTimeZone::getLocation()}.
*/
public function __construct(array $location)
{
$this->location = $location;
}
/**
* Returns the {@link $country_code}, {@link $latitude}, {@link $longitude} and
* {@link $comments} properties.
*
* @throws PropertyNotDefined in attempt to get an unsupported property.
*
* @inheritdoc
*/
public function __get($property)
{
if (isset($this->location[$property]))
{
return $this->location[$property];
}
if (class_exists('ICanBoogie\PropertyNotDefined'))
{
throw new PropertyNotDefined([ $property, $this ]);
}
else
{
throw new \RuntimeException("Property is not defined: $property.");
}
}
/**
* @throws PropertyNotWritable in attempt to set an unsupported property.
*
* @inheritdoc
*/
public function __set($property, $value)
{
if (class_exists('ICanBoogie\PropertyNotWritable'))
{
throw new PropertyNotWritable([ $property, $this ]);
}
else
{
throw new \RuntimeException("Property is not writable: $property.");
}
}
/**
* Returns the instance formatted as "{$country_code},{$latitude},{$longitude}".
*
* @return string
*/
public function __toString()
{
return "{$this->country_code},{$this->latitude},{$this->longitude}";
}
}