|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Spatie\OpeningHours; |
|
4
|
|
|
|
|
5
|
|
|
use Spatie\OpeningHours\Exceptions\InvalidTimeRangeArray; |
|
6
|
|
|
use Spatie\OpeningHours\Exceptions\InvalidTimeRangeList; |
|
7
|
|
|
use Spatie\OpeningHours\Exceptions\InvalidTimeRangeString; |
|
8
|
|
|
use Spatie\OpeningHours\Helpers\DataTrait; |
|
9
|
|
|
|
|
10
|
|
|
class TimeRange |
|
11
|
|
|
{ |
|
12
|
|
|
use DataTrait; |
|
13
|
|
|
|
|
14
|
|
|
/** @var \Spatie\OpeningHours\Time */ |
|
15
|
|
|
protected $start; |
|
16
|
|
|
|
|
17
|
|
|
/** @var \Spatie\OpeningHours\Time */ |
|
18
|
|
|
protected $end; |
|
19
|
|
|
|
|
20
|
|
|
protected function __construct(Time $start, Time $end) |
|
21
|
|
|
{ |
|
22
|
|
|
$this->start = $start; |
|
23
|
|
|
$this->end = $end; |
|
24
|
|
|
} |
|
25
|
|
|
|
|
26
|
|
|
public static function fromString(string $string): self |
|
27
|
|
|
{ |
|
28
|
|
|
$times = explode('-', $string); |
|
29
|
|
|
|
|
30
|
|
|
if (count($times) !== 2) { |
|
31
|
|
|
throw InvalidTimeRangeString::forString($string); |
|
32
|
|
|
} |
|
33
|
|
|
|
|
34
|
|
|
return new self(Time::fromString($times[0]), Time::fromString($times[1])); |
|
35
|
|
|
} |
|
36
|
|
|
|
|
37
|
|
|
public static function fromArray(array $array): self |
|
38
|
|
|
{ |
|
39
|
|
|
$values = []; |
|
40
|
|
|
$keys = ['hours', 'data']; |
|
41
|
|
|
|
|
42
|
|
|
foreach ($keys as $key) { |
|
43
|
|
|
if (isset($array[$key])) { |
|
44
|
|
|
$values[$key] = $array[$key]; |
|
45
|
|
|
unset($array[$key]); |
|
46
|
|
|
|
|
47
|
|
|
continue; |
|
48
|
|
|
} |
|
49
|
|
|
} |
|
50
|
|
|
|
|
51
|
|
|
foreach ($keys as $key) { |
|
52
|
|
|
if (! isset($values[$key])) { |
|
53
|
|
|
$values[$key] = array_shift($array); |
|
54
|
|
|
} |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
|
|
if (! $values['hours']) { |
|
58
|
|
|
throw InvalidTimeRangeArray::create(); |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
return static::fromString($values['hours'])->setData($values['data']); |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
public static function fromDefinition($value): self |
|
65
|
|
|
{ |
|
66
|
|
|
return is_array($value) ? static::fromArray($value) : static::fromString($value); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
public static function fromList(array $ranges): self |
|
70
|
|
|
{ |
|
71
|
|
|
if (count($ranges) === 0) { |
|
72
|
|
|
throw InvalidTimeRangeList::create(); |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
foreach ($ranges as $range) { |
|
76
|
|
|
if (! ($range instanceof self)) { |
|
77
|
|
|
throw InvalidTimeRangeList::create(); |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
$start = $ranges[0]->start(); |
|
82
|
|
|
$end = $ranges[0]->end(); |
|
83
|
|
|
|
|
84
|
|
|
foreach (array_slice($ranges, 1) as $range) { |
|
85
|
|
|
$rangeStart = $range->start(); |
|
86
|
|
|
if ($rangeStart->isBefore($start)) { |
|
87
|
|
|
$start = $rangeStart; |
|
88
|
|
|
} |
|
89
|
|
|
$rangeEnd = $range->end(); |
|
90
|
|
|
if ($rangeEnd->isAfter($end)) { |
|
91
|
|
|
$end = $rangeEnd; |
|
92
|
|
|
} |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
return new self($start, $end); |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
public static function fromMidnight(Time $end) |
|
99
|
|
|
{ |
|
100
|
|
|
return new self(Time::fromString('00:00'), $end); |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
public function start(): Time |
|
104
|
|
|
{ |
|
105
|
|
|
return $this->start; |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
|
|
public function end(): Time |
|
109
|
|
|
{ |
|
110
|
|
|
return $this->end; |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
public function isReversed(): bool |
|
114
|
|
|
{ |
|
115
|
|
|
return $this->start()->isAfter($this->end()); |
|
|
|
|
|
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
public function overflowsNextDay(): bool |
|
119
|
|
|
{ |
|
120
|
|
|
return $this->isReversed(); |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
public function spillsOverToNextDay(): bool |
|
124
|
|
|
{ |
|
125
|
|
|
return $this->isReversed(); |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
|
|
public function containsTime(Time $time): bool |
|
129
|
|
|
{ |
|
130
|
|
|
return $time->isSameOrAfter($this->start) && ($this->overflowsNextDay() || $time->isBefore($this->end)); |
|
|
|
|
|
|
131
|
|
|
} |
|
132
|
|
|
|
|
133
|
|
|
public function containsNightTime(Time $time): bool |
|
134
|
|
|
{ |
|
135
|
|
|
return $this->overflowsNextDay() && self::fromMidnight($this->end())->containsTime($time); |
|
136
|
|
|
} |
|
137
|
|
|
|
|
138
|
|
|
public function overlaps(self $timeRange): bool |
|
139
|
|
|
{ |
|
140
|
|
|
return $this->containsTime($timeRange->start) || $this->containsTime($timeRange->end); |
|
141
|
|
|
} |
|
142
|
|
|
|
|
143
|
|
|
public function format(string $timeFormat = 'H:i', string $rangeFormat = '%s-%s', $timezone = null): string |
|
144
|
|
|
{ |
|
145
|
|
|
return sprintf($rangeFormat, $this->start->format($timeFormat, $timezone), $this->end->format($timeFormat, $timezone)); |
|
146
|
|
|
} |
|
147
|
|
|
|
|
148
|
|
|
public function __toString(): string |
|
149
|
|
|
{ |
|
150
|
|
|
return $this->format(); |
|
151
|
|
|
} |
|
152
|
|
|
} |
|
153
|
|
|
|
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: