1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace ValueObjects\DateTime; |
4
|
|
|
|
5
|
|
|
use ValueObjects\DateTime\Exception\InvalidTimeZoneException; |
6
|
|
|
use ValueObjects\StringLiteral\StringLiteral; |
7
|
|
|
use ValueObjects\Util\Util; |
8
|
|
|
use ValueObjects\ValueObjectInterface; |
9
|
|
|
|
10
|
|
|
class TimeZone implements ValueObjectInterface |
11
|
|
|
{ |
12
|
|
|
/** @var StringLiteral */ |
13
|
|
|
protected $name; |
14
|
|
|
|
15
|
|
|
/** |
16
|
|
|
* Returns a new Time object from native timezone name |
17
|
|
|
* |
18
|
|
|
* @param string $name |
|
|
|
|
19
|
|
|
* |
20
|
|
|
* @return self |
21
|
|
|
*/ |
22
|
4 |
|
public static function fromNative() |
23
|
|
|
{ |
24
|
4 |
|
$args = func_get_args(); |
25
|
|
|
|
26
|
4 |
|
$name = new StringLiteral($args[0]); |
27
|
|
|
|
28
|
4 |
|
return new static($name); |
29
|
|
|
} |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* Returns a new Time from a native PHP \DateTime |
33
|
|
|
* |
34
|
|
|
* @param \DateTimeZone $timezone |
35
|
|
|
* |
36
|
|
|
* @return self |
37
|
|
|
*/ |
38
|
2 |
|
public static function fromNativeDateTimeZone(\DateTimeZone $timezone) |
39
|
|
|
{ |
40
|
2 |
|
return static::fromNative($timezone->getName()); |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* Returns default TimeZone |
45
|
|
|
* |
46
|
|
|
* @return self |
47
|
|
|
*/ |
48
|
2 |
|
public static function fromDefault() |
49
|
|
|
{ |
50
|
2 |
|
return new static(new StringLiteral(date_default_timezone_get())); |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* Returns a new TimeZone object |
55
|
|
|
* |
56
|
|
|
* @param StringLiteral $name |
57
|
|
|
* |
58
|
|
|
* @throws InvalidTimeZoneException |
59
|
|
|
*/ |
60
|
17 |
|
public function __construct(StringLiteral $name) |
61
|
|
|
{ |
62
|
17 |
|
$availableTimezones = timezone_identifiers_list(); |
63
|
17 |
|
$availableTimezones[] = 'Z'; |
64
|
|
|
|
65
|
17 |
|
if (!in_array($name->toNative(), $availableTimezones) |
66
|
17 |
|
&& !preg_match('/[+-]\d{2}:?\d{2}/', $name->toNative()) |
67
|
17 |
|
) { |
68
|
1 |
|
throw new InvalidTimeZoneException($name); |
69
|
|
|
} |
70
|
|
|
|
71
|
16 |
|
$this->name = $name; |
72
|
16 |
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* Returns a native PHP \DateTimeZone version of the current TimeZone. |
76
|
|
|
* |
77
|
|
|
* @return \DateTimeZone |
78
|
|
|
*/ |
79
|
3 |
|
public function toNativeDateTimeZone() |
80
|
|
|
{ |
81
|
3 |
|
return new \DateTimeZone($this->getName()->toNative()); |
82
|
|
|
} |
83
|
|
|
|
84
|
|
|
/** |
85
|
|
|
* Tells whether two DateTimeZone are equal by comparing their names |
86
|
|
|
* |
87
|
|
|
* @param ValueObjectInterface $timezone |
88
|
|
|
* |
89
|
|
|
* @return bool |
90
|
|
|
*/ |
91
|
7 |
|
public function sameValueAs(ValueObjectInterface $timezone) |
92
|
|
|
{ |
93
|
7 |
|
if (FALSE === Util::classEquals($this, $timezone)) { |
94
|
1 |
|
return FALSE; |
95
|
|
|
} |
96
|
|
|
|
97
|
7 |
|
return $this->getName()->sameValueAs($timezone->getName()); |
|
|
|
|
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
/** |
101
|
|
|
* Returns timezone name |
102
|
|
|
* |
103
|
|
|
* @return StringLiteral |
104
|
|
|
*/ |
105
|
15 |
|
public function getName() |
106
|
|
|
{ |
107
|
15 |
|
return clone $this->name; |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* Returns timezone name as string |
112
|
|
|
* |
113
|
|
|
* @return string |
114
|
|
|
*/ |
115
|
4 |
|
public function __toString() |
116
|
|
|
{ |
117
|
4 |
|
return $this->getName()->__toString(); |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
function jsonSerialize() |
|
|
|
|
121
|
|
|
{ |
122
|
|
|
return (string)$this; |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
|
126
|
|
|
} |
127
|
|
|
|
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.