1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Ogone\Subscription; |
4
|
|
|
|
5
|
|
|
use InvalidArgumentException; |
6
|
|
|
|
7
|
|
|
class SubscriptionPeriod |
8
|
|
|
{ |
9
|
|
|
|
10
|
|
|
/** @var string */ |
11
|
|
|
const UNIT_DAILY = 'd'; |
12
|
|
|
|
13
|
|
|
/** @var string */ |
14
|
|
|
const UNIT_WEEKLY = 'ww'; |
15
|
|
|
|
16
|
|
|
/** @var string */ |
17
|
|
|
const UNIT_MONTHLY = 'm'; |
18
|
|
|
|
19
|
|
|
/** |
20
|
|
|
* @var string |
21
|
|
|
* ‘d’ = daily, ‘ww’ = weekly, ‘m’ = monthly |
22
|
|
|
*/ |
23
|
|
|
protected $unit; |
24
|
|
|
|
25
|
|
|
/** |
26
|
|
|
* @var int |
27
|
|
|
* Interval between each occurrence of the subscription payments |
28
|
|
|
*/ |
29
|
|
|
protected $interval; |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* @var int |
33
|
|
|
* Depending on sub_period_unit |
34
|
|
|
* Daily (d): |
35
|
|
|
* interval in days |
36
|
|
|
* Weekly (ww): |
37
|
|
|
* 1=Sunday, … 7=Saturday |
38
|
|
|
* Monthly (m): |
39
|
|
|
* day of the month |
40
|
|
|
*/ |
41
|
|
|
protected $moment; |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* @param string $unit |
45
|
|
|
* @param int $interval |
46
|
|
|
* @param int $moment |
47
|
|
|
* @throws InvalidArgumentException |
48
|
|
|
*/ |
49
|
23 |
|
public function __construct($unit, $interval, $moment) |
50
|
|
|
{ |
51
|
23 |
|
$this->setUnit($unit); |
52
|
22 |
|
$this->setInterval($interval); |
53
|
19 |
|
$this->setMoment($moment); |
54
|
14 |
|
} |
55
|
|
|
|
56
|
|
|
/** |
57
|
|
|
* @return string |
58
|
|
|
*/ |
59
|
4 |
|
public function getUnit() |
60
|
|
|
{ |
61
|
4 |
|
return $this->unit; |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* @param string $unit |
66
|
|
|
* @throws InvalidArgumentException |
67
|
|
|
*/ |
68
|
23 |
|
public function setUnit($unit) |
69
|
|
|
{ |
70
|
23 |
|
if (!in_array($unit, array(self::UNIT_DAILY, self::UNIT_WEEKLY, self::UNIT_MONTHLY))) { |
71
|
1 |
|
throw new InvalidArgumentException("Subscription period unit should be '".self::UNIT_DAILY."' (daily), '".self::UNIT_WEEKLY."' (weekly) or '".self::UNIT_MONTHLY."' (monthly)"); |
72
|
|
|
} |
73
|
|
|
|
74
|
22 |
View Code Duplication |
if (self::UNIT_WEEKLY === $unit) { |
|
|
|
|
75
|
3 |
|
if ($this->moment > 7) { |
76
|
1 |
|
throw new InvalidArgumentException('The unit cannot be set to weekly while the moment > 7'); |
77
|
|
|
} |
78
|
20 |
|
} elseif (self::UNIT_MONTHLY === $unit && $this->moment > 28) { |
79
|
1 |
|
throw new InvalidArgumentException('The unit cannot be set to monthly while the moment > 28'); |
80
|
|
|
} |
81
|
22 |
|
$this->unit = $unit; |
82
|
22 |
|
} |
83
|
|
|
|
84
|
|
|
/** |
85
|
|
|
* @return int |
86
|
|
|
*/ |
87
|
5 |
|
public function getInterval() |
88
|
|
|
{ |
89
|
5 |
|
return $this->interval; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
/** |
93
|
|
|
* @param int $interval |
94
|
|
|
* @throws InvalidArgumentException |
95
|
|
|
*/ |
96
|
22 |
|
public function setInterval($interval) |
97
|
|
|
{ |
98
|
22 |
|
if (!is_int($interval)) { |
99
|
1 |
|
throw new InvalidArgumentException("Integer expected for interval"); |
100
|
|
|
} |
101
|
21 |
|
if ($interval < 0) { |
102
|
1 |
|
throw new InvalidArgumentException("Interval must be a positive number > 0"); |
103
|
|
|
} |
104
|
20 |
|
if ($interval >= 1.0E+15) { |
105
|
1 |
|
throw new InvalidArgumentException("Interval is too high"); |
106
|
|
|
} |
107
|
19 |
|
$this->interval = $interval; |
108
|
19 |
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* @return int |
112
|
|
|
*/ |
113
|
5 |
|
public function getMoment() |
114
|
|
|
{ |
115
|
5 |
|
return $this->moment; |
116
|
|
|
} |
117
|
|
|
|
118
|
|
|
/** |
119
|
|
|
* @param int $moment |
120
|
|
|
* @throws InvalidArgumentException |
121
|
|
|
*/ |
122
|
19 |
|
public function setMoment($moment) |
123
|
|
|
{ |
124
|
19 |
|
if (!is_int($moment)) { |
125
|
1 |
|
throw new InvalidArgumentException("Integer expected for moment"); |
126
|
|
|
} |
127
|
18 |
|
if ($moment <= 0) { |
128
|
1 |
|
throw new InvalidArgumentException("Moment must be a positive number"); |
129
|
|
|
} |
130
|
17 |
|
if ($moment >= 1.0E+15) { |
131
|
1 |
|
throw new InvalidArgumentException("Interval is too high"); |
132
|
|
|
} |
133
|
|
|
|
134
|
16 |
View Code Duplication |
if (self::UNIT_WEEKLY == $this->unit) { |
|
|
|
|
135
|
|
|
// Valid values are 1 to 7 |
136
|
2 |
|
if ($moment > 7) { |
137
|
1 |
|
throw new InvalidArgumentException("Moment should be 1 (Sunday), 2, 3 .. 7 (Saturday)"); |
138
|
|
|
} |
139
|
14 |
|
} elseif (self::UNIT_MONTHLY == $this->unit && $moment > 28) { |
140
|
|
|
// We will not allow a day of month > 28 |
141
|
1 |
|
throw new InvalidArgumentException("Moment can't be larger than 29. Last day for month allowed is 28."); |
142
|
|
|
} |
143
|
|
|
|
144
|
14 |
|
$this->moment = $moment; |
145
|
14 |
|
} |
146
|
|
|
} |
147
|
|
|
|
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.