-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
DateTimeWidget.php
628 lines (573 loc) · 20.5 KB
/
DateTimeWidget.php
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Widget;
use Cake\View\Form\ContextInterface;
use Cake\View\StringTemplate;
use DateTime;
use Exception;
use RuntimeException;
/**
* Input widget class for generating a date time input widget.
*
* This class is intended as an internal implementation detail
* of Cake\View\Helper\FormHelper and is not intended for direct use.
*/
class DateTimeWidget implements WidgetInterface
{
/**
* Select box widget.
*
* @var \Cake\View\Widget\SelectBoxWidget
*/
protected $_select;
/**
* List of inputs that can be rendered
*
* @var string[]
*/
protected $_selects = [
'year',
'month',
'day',
'hour',
'minute',
'second',
'meridian',
];
/**
* Template instance.
*
* @var \Cake\View\StringTemplate
*/
protected $_templates;
/**
* Constructor
*
* @param \Cake\View\StringTemplate $templates Templates list.
* @param \Cake\View\Widget\SelectBoxWidget $selectBox Selectbox widget instance.
*/
public function __construct(StringTemplate $templates, SelectBoxWidget $selectBox)
{
$this->_select = $selectBox;
$this->_templates = $templates;
}
/**
* Renders a date time widget
*
* - `name` - Set the input name.
* - `disabled` - Either true or an array of options to disable.
* - `val` - A date time string, integer or DateTime object
* - `empty` - Set to true to add an empty option at the top of the
* option elements. Set to a string to define the display value of the
* empty option.
*
* In addition to the above options, the following options allow you to control
* which input elements are generated. By setting any option to false you can disable
* that input picker. In addition each picker allows you to set additional options
* that are set as HTML properties on the picker.
*
* - `year` - Array of options for the year select box.
* - `month` - Array of options for the month select box.
* - `day` - Array of options for the day select box.
* - `hour` - Array of options for the hour select box.
* - `minute` - Array of options for the minute select box.
* - `second` - Set to true to enable the seconds input. Defaults to false.
* - `meridian` - Set to true to enable the meridian input. Defaults to false.
* The meridian will be enabled automatically if you choose a 12 hour format.
*
* The `year` option accepts the `start` and `end` options. These let you control
* the year range that is generated. It defaults to +-5 years from today.
*
* The `month` option accepts the `name` option which allows you to get month
* names instead of month numbers.
*
* The `hour` option allows you to set the following options:
*
* - `format` option which accepts 12 or 24, allowing
* you to indicate which hour format you want.
* - `start` The hour to start the options at.
* - `end` The hour to stop the options at.
*
* The start and end options are dependent on the format used. If the
* value is out of the start/end range it will not be included.
*
* The `minute` option allows you to define the following options:
*
* - `interval` The interval to round options to.
* - `round` Accepts `up` or `down`. Defines which direction the current value
* should be rounded to match the select options.
*
* @param array $data Data to render with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string A generated select box.
* @throws \RuntimeException When option data is invalid.
*/
public function render(array $data, ContextInterface $context)
{
$data = $this->_normalizeData($data);
$selected = $this->_deconstructDate($data['val'], $data);
$templateOptions = ['templateVars' => $data['templateVars']];
foreach ($this->_selects as $select) {
if ($data[$select] === false || $data[$select] === null) {
$templateOptions[$select] = '';
unset($data[$select]);
continue;
}
if (!is_array($data[$select])) {
throw new RuntimeException(sprintf(
'Options for "%s" must be an array|false|null',
$select
));
}
$method = "_{$select}Select";
$data[$select]['name'] = $data['name'] . '[' . $select . ']';
$data[$select]['val'] = $selected[$select];
if (!isset($data[$select]['empty'])) {
$data[$select]['empty'] = $data['empty'];
}
if (!isset($data[$select]['disabled'])) {
$data[$select]['disabled'] = $data['disabled'];
}
if (isset($data[$select]['templateVars']) && $templateOptions['templateVars']) {
$data[$select]['templateVars'] = array_merge(
$templateOptions['templateVars'],
$data[$select]['templateVars']
);
}
if (!isset($data[$select]['templateVars'])) {
$data[$select]['templateVars'] = $templateOptions['templateVars'];
}
$templateOptions[$select] = $this->{$method}($data[$select], $context);
unset($data[$select]);
}
unset($data['name'], $data['empty'], $data['disabled'], $data['val']);
$templateOptions['attrs'] = $this->_templates->formatAttributes($data);
return $this->_templates->format('dateWidget', $templateOptions);
}
/**
* Normalize data.
*
* @param array $data Data to normalize.
* @return array Normalized data.
*/
protected function _normalizeData($data)
{
$data += [
'name' => '',
'empty' => false,
'disabled' => null,
'val' => null,
'year' => [],
'month' => [],
'day' => [],
'hour' => [],
'minute' => [],
'second' => [],
'meridian' => null,
'templateVars' => [],
];
$timeFormat = isset($data['hour']['format']) ? $data['hour']['format'] : null;
if ($timeFormat === 12 && !isset($data['meridian'])) {
$data['meridian'] = [];
}
if ($timeFormat === 24) {
$data['meridian'] = false;
}
return $data;
}
/**
* Deconstructs the passed date value into all time units
*
* @param string|int|array|\DateTime|null $value Value to deconstruct.
* @param array $options Options for conversion.
* @return array
*/
protected function _deconstructDate($value, $options)
{
if ($value === '' || $value === null) {
return [
'year' => '', 'month' => '', 'day' => '',
'hour' => '', 'minute' => '', 'second' => '',
'meridian' => '',
];
}
try {
if (is_string($value) && !is_numeric($value)) {
$date = new DateTime($value);
} elseif (is_bool($value)) {
$date = new DateTime();
} elseif (is_int($value) || is_numeric($value)) {
$date = new DateTime('@' . $value);
} elseif (is_array($value)) {
$dateArray = [
'year' => '', 'month' => '', 'day' => '',
'hour' => '', 'minute' => '', 'second' => '',
'meridian' => '',
];
$validDate = false;
foreach ($dateArray as $key => $dateValue) {
$exists = isset($value[$key]);
if ($exists) {
$validDate = true;
}
if ($exists && $value[$key] !== '') {
$dateArray[$key] = str_pad($value[$key], 2, '0', STR_PAD_LEFT);
}
}
if ($validDate) {
if (!isset($dateArray['second'])) {
$dateArray['second'] = 0;
}
if (!empty($value['meridian'])) {
$isAm = strtolower($dateArray['meridian']) === 'am';
$dateArray['hour'] = $isAm ? $dateArray['hour'] : $dateArray['hour'] + 12;
}
if (!empty($dateArray['minute']) && isset($options['minute']['interval'])) {
$dateArray['minute'] += $this->_adjustValue($dateArray['minute'], $options['minute']);
$dateArray['minute'] = str_pad((string)$dateArray['minute'], 2, '0', STR_PAD_LEFT);
}
return $dateArray;
}
$date = new DateTime();
} else {
/** @var \DateTime $value */
$date = clone $value;
}
} catch (Exception $e) {
$date = new DateTime();
}
if (isset($options['minute']['interval'])) {
$change = $this->_adjustValue((int)$date->format('i'), $options['minute']);
$date->modify($change > 0 ? "+$change minutes" : "$change minutes");
}
return [
'year' => $date->format('Y'),
'month' => $date->format('m'),
'day' => $date->format('d'),
'hour' => $date->format('H'),
'minute' => $date->format('i'),
'second' => $date->format('s'),
'meridian' => $date->format('a'),
];
}
/**
* Adjust $value based on rounding settings.
*
* @param int $value The value to adjust.
* @param array $options The options containing interval and possibly round.
* @return int The amount to adjust $value by.
*/
protected function _adjustValue($value, $options)
{
$options += ['interval' => 1, 'round' => null];
$changeValue = $value * (1 / $options['interval']);
switch ($options['round']) {
case 'up':
$changeValue = ceil($changeValue);
break;
case 'down':
$changeValue = floor($changeValue);
break;
default:
$changeValue = round($changeValue);
}
return ($changeValue * $options['interval']) - $value;
}
/**
* Generates a year select
*
* @param array $options Options list.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _yearSelect($options, $context)
{
$options += [
'name' => '',
'val' => null,
'start' => date('Y', strtotime('-5 years')),
'end' => date('Y', strtotime('+5 years')),
'order' => 'desc',
'templateVars' => [],
'options' => [],
];
if (!empty($options['val'])) {
$options['start'] = min($options['val'], $options['start']);
$options['end'] = max($options['val'], $options['end']);
}
if (empty($options['options'])) {
$options['options'] = $this->_generateNumbers($options['start'], $options['end']);
}
if ($options['order'] === 'desc') {
$options['options'] = array_reverse($options['options'], true);
}
unset($options['start'], $options['end'], $options['order']);
return $this->_select->render($options, $context);
}
/**
* Generates a month select
*
* @param array $options The options to build the month select with
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _monthSelect($options, $context)
{
$options += [
'name' => '',
'names' => false,
'val' => null,
'leadingZeroKey' => true,
'leadingZeroValue' => false,
'templateVars' => [],
];
if (empty($options['options'])) {
if ($options['names'] === true) {
$options['options'] = $this->_getMonthNames($options['leadingZeroKey']);
} elseif (is_array($options['names'])) {
$options['options'] = $options['names'];
} else {
$options['options'] = $this->_generateNumbers(1, 12, $options);
}
}
unset($options['leadingZeroKey'], $options['leadingZeroValue'], $options['names']);
return $this->_select->render($options, $context);
}
/**
* Generates a day select
*
* @param array $options The options to generate a day select with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _daySelect($options, $context)
{
$options += [
'name' => '',
'val' => null,
'leadingZeroKey' => true,
'leadingZeroValue' => false,
'templateVars' => [],
];
$options['options'] = $this->_generateNumbers(1, 31, $options);
unset($options['names'], $options['leadingZeroKey'], $options['leadingZeroValue']);
return $this->_select->render($options, $context);
}
/**
* Generates a hour select
*
* @param array $options The options to generate an hour select with
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _hourSelect($options, $context)
{
$options += [
'name' => '',
'val' => null,
'format' => 24,
'start' => null,
'end' => null,
'leadingZeroKey' => true,
'leadingZeroValue' => false,
'templateVars' => [],
];
$is24 = $options['format'] == 24;
$defaultStart = $is24 ? 0 : 1;
$defaultEnd = $is24 ? 23 : 12;
$options['start'] = max($defaultStart, $options['start']);
$options['end'] = min($defaultEnd, $options['end']);
if ($options['end'] === null) {
$options['end'] = $defaultEnd;
}
if (!$is24 && $options['val'] > 12) {
$options['val'] = sprintf('%02d', $options['val'] - 12);
}
if (!$is24 && in_array($options['val'], ['00', '0', 0], true)) {
$options['val'] = 12;
}
if (empty($options['options'])) {
$options['options'] = $this->_generateNumbers(
$options['start'],
$options['end'],
$options
);
}
unset(
$options['end'],
$options['start'],
$options['format'],
$options['leadingZeroKey'],
$options['leadingZeroValue']
);
return $this->_select->render($options, $context);
}
/**
* Generates a minute select
*
* @param array $options The options to generate a minute select with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _minuteSelect($options, $context)
{
$options += [
'name' => '',
'val' => null,
'interval' => 1,
'round' => 'up',
'leadingZeroKey' => true,
'leadingZeroValue' => true,
'templateVars' => [],
];
$options['interval'] = max($options['interval'], 1);
if (empty($options['options'])) {
$options['options'] = $this->_generateNumbers(0, 59, $options);
}
unset(
$options['leadingZeroKey'],
$options['leadingZeroValue'],
$options['interval'],
$options['round']
);
return $this->_select->render($options, $context);
}
/**
* Generates a second select
*
* @param array $options The options to generate a second select with
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _secondSelect($options, $context)
{
$options += [
'name' => '',
'val' => null,
'leadingZeroKey' => true,
'leadingZeroValue' => true,
'options' => $this->_generateNumbers(0, 59),
'templateVars' => [],
];
unset($options['leadingZeroKey'], $options['leadingZeroValue']);
return $this->_select->render($options, $context);
}
/**
* Generates a meridian select
*
* @param array $options The options to generate a meridian select with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
protected function _meridianSelect($options, $context)
{
$options += [
'name' => '',
'val' => null,
'options' => ['am' => 'am', 'pm' => 'pm'],
'templateVars' => [],
];
return $this->_select->render($options, $context);
}
/**
* Returns a translated list of month names
*
* @param bool $leadingZero Whether to generate month keys with leading zero.
* @return array
*/
protected function _getMonthNames($leadingZero = false)
{
$months = [
'01' => __d('cake', 'January'),
'02' => __d('cake', 'February'),
'03' => __d('cake', 'March'),
'04' => __d('cake', 'April'),
'05' => __d('cake', 'May'),
'06' => __d('cake', 'June'),
'07' => __d('cake', 'July'),
'08' => __d('cake', 'August'),
'09' => __d('cake', 'September'),
'10' => __d('cake', 'October'),
'11' => __d('cake', 'November'),
'12' => __d('cake', 'December'),
];
if ($leadingZero === false) {
$i = 1;
foreach ($months as $key => $name) {
unset($months[$key]);
$months[$i++] = $name;
}
}
return $months;
}
/**
* Generates a range of numbers
*
* ### Options
*
* - leadingZeroKey - Set to true to add a leading 0 to single digit keys.
* - leadingZeroValue - Set to true to add a leading 0 to single digit values.
* - interval - The interval to generate numbers for. Defaults to 1.
*
* @param int $start Start of the range of numbers to generate
* @param int $end End of the range of numbers to generate
* @param array $options Options list.
* @return array
*/
protected function _generateNumbers($start, $end, $options = [])
{
$options += [
'leadingZeroKey' => true,
'leadingZeroValue' => true,
'interval' => 1,
];
$numbers = [];
$i = $start;
while ($i <= $end) {
$key = (string)$i;
$value = (string)$i;
if ($options['leadingZeroKey'] === true) {
$key = sprintf('%02d', $key);
}
if ($options['leadingZeroValue'] === true) {
$value = sprintf('%02d', $value);
}
$numbers[$key] = $value;
$i += $options['interval'];
}
return $numbers;
}
/**
* Returns a list of fields that need to be secured for this widget.
*
* When the hour picker is in 24hr mode (null or format=24) the meridian
* picker will be omitted.
*
* @param array $data The data to render.
* @return array Array of fields to secure.
*/
public function secureFields(array $data)
{
$data = $this->_normalizeData($data);
$fields = [];
foreach ($this->_selects as $select) {
if ($data[$select] === false || $data[$select] === null) {
continue;
}
$fields[] = $data['name'] . '[' . $select . ']';
}
return $fields;
}
}