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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 <?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 timezone.
*
* <pre>
* <?php
*
* use ICanBoogie\TimeZone;
*
* $zone = new TimeZone('Europe/Paris');
*
* echo $zone; // "Europe/Paris"
* echo $zone->offset; // 3600
* echo $zone->location; // FR,48.86667,2.33333
* echo $zone->location->latitude; // 48.86667
* echo $zone->is_utc; // false
* echo $zone->is_local; // true
* </pre>
*
* @property-read TimeZoneLocation $location Location information for the timezone.
* @property-read string $name Name of the timezone.
* @property-read int $offset Timezone offset from UTC.
* @property-read bool $is_utc `true` Time zone is `UTC`, `false` otherwise.
* @property-read bool $is_local `true` if time zone is local, `false` otherwise.
*/
class TimeZone extends \DateTimeZone
{
static private $utc_time;
static private $cache;
/**
* Returns a timezone according to the specified source.
*
* If the source is already an instance of {@link Zone}, it is returned as is.
*
* Note: Instances created by the method are shared. That is, equivalent sources yield
* the same instance.
*
* @param mixed $source Source of the timezone.
*
* @return TimeZone
*/
static public function from($source)
{
if ($source instanceof self)
{
return $source;
}
else if ($source instanceof \DateTimeZone)
{
$source = $source->getName();
}
$source = (string) $source;
if (empty(self::$cache[$source]))
{
self::$cache[$source] = new static($source);
}
return self::$cache[$source];
}
/**
* The name of the timezone.
*
* Note: This variable is only used to provide information during debugging.
*
* @var string
*/
private $name;
/**
* Location of the timezone.
*
* @var TimeZoneLocation
*/
private $location;
/**
* Initializes the {@link $name} property.
*
* @param string $timezone
*/
public function __construct($timezone)
{
parent::__construct($timezone);
$name = $this->getName();
$this->name = $name === 'utc' ? 'UTC' : $name;
}
/**
* @throws \LogicException in attempt to get an undefined property.
*
* @inheritdoc
*/
public function __get($property)
{
$getter = "get_$property";
if (!method_exists($this, $getter))
{
throw new \LogicException("Property not defined: $property.");
}
return $this->$getter();
}
/**
* @inheritdoc
*
* @throws \LogicException in attempt to write any property.
*/
public function __set($property, $value)
{
throw new \LogicException("Property no writable: $property.");
}
/**
* @return TimeZoneLocation
*/
protected function get_location()
{
$location = &$this->location;
return $location ?: $location = TimeZoneLocation::from($this);
}
/**
* @return string
*/
protected function get_name()
{
return $this->name;
}
/**
* @return int
*/
protected function get_offset()
{
$utc_time = &self::$utc_time;
if (!$utc_time)
{
$utc_time = new \DateTime('now', new \DateTimeZone('utc'));
}
return $this->getOffset($utc_time);
}
/**
* @return bool `true` if time zone is `UTC`, `false` otherwise.
*/
protected function get_is_utc()
{
return $this->name === 'UTC';
}
/**
* @return bool `true` if time zone is local, `false` otherwise.
*/
protected function get_is_local()
{
return $this->name === date_default_timezone_get();
}
/**
* Returns the name of the timezone.
*
* @return string
*/
public function __toString()
{
return $this->name;
}
}