1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace mindplay\kissform\Fields; |
4
|
|
|
|
5
|
|
|
use DateTime; |
6
|
|
|
use InvalidArgumentException; |
7
|
|
|
use mindplay\kissform\Facets\ParserInterface; |
8
|
|
|
use mindplay\kissform\Fields\Base\TimeZoneAwareField; |
9
|
|
|
use mindplay\kissform\InputModel; |
10
|
|
|
use mindplay\kissform\InputRenderer; |
11
|
|
|
use mindplay\kissform\Validators\CheckParser; |
12
|
|
|
use UnexpectedValueException; |
13
|
|
|
|
14
|
|
|
/** |
15
|
|
|
* Date/time field-type for string-based input. |
16
|
|
|
*/ |
17
|
|
|
class DateTimeField extends TimeZoneAwareField implements ParserInterface |
18
|
|
|
{ |
19
|
|
|
/** |
20
|
|
|
* @var string input date/time format string |
21
|
|
|
*/ |
22
|
|
|
public $format; |
23
|
|
|
|
24
|
|
|
/** |
25
|
|
|
* @var string[] map of HTML attributes to apply |
26
|
|
|
*/ |
27
|
|
|
public $attrs; |
28
|
|
|
|
29
|
|
|
/** |
30
|
|
|
* @param string $name field name |
31
|
|
|
* @param string $timezone timezone name |
32
|
|
|
* @param string $format date/time format compatible with the date() function |
33
|
|
|
* @param array $attrs map of HTML attribtues to apply |
34
|
|
|
* |
35
|
|
|
* @see date() |
36
|
|
|
*/ |
37
|
5 |
|
public function __construct($name, $timezone, $format, $attrs = []) |
38
|
|
|
{ |
39
|
5 |
|
parent::__construct($name); |
40
|
|
|
|
41
|
5 |
|
$this->setTimeZone($timezone); |
42
|
|
|
|
43
|
5 |
|
$this->format = $format; |
44
|
5 |
|
$this->attrs = $attrs; |
45
|
5 |
|
} |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* @param string $input |
49
|
|
|
* |
50
|
|
|
* @return int|null |
51
|
|
|
*/ |
52
|
2 |
|
public function parseInput($input) |
53
|
|
|
{ |
54
|
2 |
|
$time = @date_create_from_format($this->format, $input, $this->timezone); |
55
|
|
|
|
56
|
2 |
|
return $time && ($time->format($this->format) == $input) |
57
|
2 |
|
? $time->getTimestamp() |
58
|
2 |
|
: null; |
59
|
|
|
} |
60
|
|
|
|
61
|
|
|
/** |
62
|
|
|
* @param InputModel $model |
63
|
|
|
* |
64
|
|
|
* @return int|null timestamp |
65
|
|
|
* |
66
|
|
|
* @throws UnexpectedValueException if unable to parse the input |
67
|
|
|
*/ |
68
|
1 |
|
public function getValue(InputModel $model) |
69
|
|
|
{ |
70
|
1 |
|
$input = $model->getInput($this); |
71
|
|
|
|
72
|
1 |
|
if (empty($input)) { |
73
|
1 |
|
return null; |
74
|
|
|
} else { |
75
|
1 |
|
$value = $this->parseInput($input); |
|
|
|
|
76
|
|
|
|
77
|
1 |
|
if ($value === null) { |
78
|
|
|
throw new UnexpectedValueException("invalid input"); |
79
|
|
|
} |
80
|
|
|
|
81
|
1 |
|
return $value; |
|
|
|
|
82
|
|
|
} |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* @param InputModel $model |
87
|
|
|
* @param int|null $value timestamp |
88
|
|
|
* |
89
|
|
|
* @return void |
90
|
|
|
* |
91
|
|
|
* @throws InvalidArgumentException if the given value is unacceptable. |
92
|
|
|
*/ |
93
|
3 |
|
public function setValue(InputModel $model, $value) |
94
|
|
|
{ |
95
|
3 |
|
if ($value === null) { |
96
|
1 |
|
$model->setInput($this, null); |
97
|
3 |
|
} elseif (is_int($value)) { |
98
|
3 |
|
$date = new DateTime(); |
99
|
3 |
|
$date->setTimestamp($value); |
100
|
3 |
|
$date->setTimezone($this->timezone); |
101
|
|
|
|
102
|
3 |
|
$model->setInput($this, $date->format($this->format)); |
103
|
|
|
} else { |
104
|
1 |
|
throw new InvalidArgumentException("integer timestamp expected"); |
105
|
|
|
} |
106
|
3 |
|
} |
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* {@inheritdoc} |
110
|
|
|
*/ |
111
|
2 |
|
public function renderInput(InputRenderer $renderer, InputModel $model, array $attr) |
112
|
|
|
{ |
113
|
2 |
|
return $renderer->inputFor($this, 'text', $attr + $this->attrs); |
114
|
|
|
} |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* {@inheritdoc} |
118
|
|
|
*/ |
119
|
1 |
|
public function createValidators() |
120
|
|
|
{ |
121
|
1 |
|
$validators = parent::createValidators(); |
122
|
|
|
|
123
|
1 |
|
$validators[] = new CheckParser($this, "datetime"); |
124
|
|
|
|
125
|
1 |
|
return $validators; |
126
|
|
|
} |
127
|
|
|
} |
128
|
|
|
|
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.