-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
DateTimeType.php
473 lines (415 loc) · 13.4 KB
/
DateTimeType.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
<?php
declare(strict_types=1);
/**
* 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\Database\Type;
use Cake\Chronos\ChronosDate;
use Cake\Database\Driver;
use Cake\Database\Exception\DatabaseException;
use Cake\I18n\DateTime;
use DateTime as NativeDateTime;
use DateTimeImmutable;
use DateTimeInterface;
use DateTimeZone;
use Exception;
use InvalidArgumentException;
use PDO;
/**
* Datetime type converter.
*
* Use to convert datetime instances to strings & back.
*/
class DateTimeType extends BaseType implements BatchCastingInterface
{
/**
* The DateTime format used when converting to string.
*
* @var string
*/
protected string $_format = 'Y-m-d H:i:s';
/**
* The DateTime formats allowed by `marshal()`.
*
* @var array<string>
*/
protected array $_marshalFormats = [
'Y-m-d H:i',
'Y-m-d H:i:s',
'Y-m-d\TH:i',
'Y-m-d\TH:i:s',
'Y-m-d\TH:i:sP',
'Y-m-d H:i:s.P',
'Y-m-d H:i:s.u',
];
/**
* Whether `marshal()` should use locale-aware parser with `_localeMarshalFormat`.
*
* @var bool
*/
protected bool $_useLocaleMarshal = false;
/**
* The locale-aware format `marshal()` uses when `_useLocaleParser` is true.
*
* See `Cake\I18n\Time::parseDateTime()` for accepted formats.
*
* @var array|string|int|null
*/
protected array|string|int|null $_localeMarshalFormat = null;
/**
* The classname to use when creating objects.
*
* @var class-string<\Cake\I18n\DateTime>|class-string<\DateTimeImmutable>
*/
protected string $_className;
/**
* Database time zone.
*
* @var \DateTimeZone|null
*/
protected ?DateTimeZone $dbTimezone = null;
/**
* User time zone.
*
* @var \DateTimeZone|null
*/
protected ?DateTimeZone $userTimezone = null;
/**
* Default time zone.
*
* @var \DateTimeZone
*/
protected DateTimeZone $defaultTimezone;
/**
* Whether database time zone is kept when converting
*
* @var bool
*/
protected bool $keepDatabaseTimezone = false;
/**
* {@inheritDoc}
*
* @param string|null $name The name identifying this type
*/
public function __construct(?string $name = null)
{
parent::__construct($name);
$this->defaultTimezone = new DateTimeZone(date_default_timezone_get());
$this->_className = class_exists(DateTime::class) ? DateTime::class : DateTimeImmutable::class;
}
/**
* Convert DateTime instance into strings.
*
* @param mixed $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return string|null
*/
public function toDatabase(mixed $value, Driver $driver): ?string
{
if ($value === null || is_string($value)) {
return $value;
}
if (is_int($value)) {
$class = $this->_className;
$value = new $class('@' . $value);
}
if ($value instanceof ChronosDate) {
return $value->format($this->_format);
}
if (!$value instanceof DateTimeInterface) {
return null;
}
if (
$this->dbTimezone !== null
&& $this->dbTimezone->getName() !== $value->getTimezone()->getName()
) {
if (!$value instanceof DateTimeImmutable) {
$value = clone $value;
}
$value = $value->setTimezone($this->dbTimezone);
}
return $value->format($this->_format);
}
/**
* Set database timezone.
*
* This is the time zone used when converting database strings to DateTime
* instances and converting DateTime instances to database strings.
*
* @see DateTimeType::setKeepDatabaseTimezone
* @param \DateTimeZone|string|null $timezone Database timezone.
* @return $this
*/
public function setDatabaseTimezone(DateTimeZone|string|null $timezone)
{
if (is_string($timezone)) {
$timezone = new DateTimeZone($timezone);
}
$this->dbTimezone = $timezone;
return $this;
}
/**
* Set user timezone.
*
* This is the time zone used when marshalling strings to DateTime instances.
*
* @param \DateTimeZone|string|null $timezone User timezone.
* @return $this
*/
public function setUserTimezone(DateTimeZone|string|null $timezone)
{
if (is_string($timezone)) {
$timezone = new DateTimeZone($timezone);
}
$this->userTimezone = $timezone;
return $this;
}
/**
* {@inheritDoc}
*
* @param mixed $value Value to be converted to PHP equivalent
* @param \Cake\Database\Driver $driver Object from which database preferences and configuration will be extracted
* @return \Cake\I18n\DateTime|\DateTimeImmutable|null
*/
public function toPHP(mixed $value, Driver $driver): DateTime|DateTimeImmutable|null
{
if ($value === null) {
return null;
}
$class = $this->_className;
if (is_int($value)) {
$instance = new $class('@' . $value);
} elseif (str_starts_with($value, '0000-00-00')) {
return null;
} else {
$instance = new $class($value, $this->dbTimezone);
}
if (
!$this->keepDatabaseTimezone
&& $instance->getTimezone()
&& $instance->getTimezone()->getName() !== $this->defaultTimezone->getName()
) {
$instance = $instance->setTimezone($this->defaultTimezone);
}
return $instance;
}
/**
* Set whether DateTime object created from database string is converted
* to default time zone.
*
* If your database date times are in a specific time zone that you want
* to keep in the DateTime instance then set this to true.
*
* When false, datetime timezones are converted to default time zone.
* This is default behavior.
*
* @param bool $keep If true, database time zone is kept when converting
* to DateTime instances.
* @return $this
*/
public function setKeepDatabaseTimezone(bool $keep)
{
$this->keepDatabaseTimezone = $keep;
return $this;
}
/**
* @inheritDoc
*/
public function manyToPHP(array $values, array $fields, Driver $driver): array
{
foreach ($fields as $field) {
if (!isset($values[$field])) {
continue;
}
$value = $values[$field];
$class = $this->_className;
if (is_int($value)) {
$instance = new $class('@' . $value);
} elseif (str_starts_with($value, '0000-00-00')) {
$values[$field] = null;
continue;
} else {
$instance = new $class($value, $this->dbTimezone);
}
if (
!$this->keepDatabaseTimezone
&& $instance->getTimezone()
&& $instance->getTimezone()->getName() !== $this->defaultTimezone->getName()
) {
$instance = $instance->setTimezone($this->defaultTimezone);
}
$values[$field] = $instance;
}
return $values;
}
/**
* Convert request data into a datetime object.
*
* @param mixed $value Request data
* @return \DateTimeInterface|null
*/
public function marshal(mixed $value): ?DateTimeInterface
{
if ($value instanceof DateTimeInterface) {
if ($value instanceof NativeDateTime) {
$value = clone $value;
}
/** @var \Datetime|\DateTimeImmutable $value */
return $value->setTimezone($this->defaultTimezone);
}
if ($value instanceof ChronosDate) {
return $value->toNative();
}
$class = $this->_className;
try {
if (is_int($value) || (is_string($value) && ctype_digit($value))) {
$dateTime = new $class('@' . $value);
return $dateTime->setTimezone($this->defaultTimezone);
}
if (is_string($value)) {
if ($this->_useLocaleMarshal) {
$dateTime = $this->_parseLocaleValue($value);
} else {
$dateTime = $this->_parseValue($value);
}
if ($dateTime) {
$dateTime = $dateTime->setTimezone($this->defaultTimezone);
}
return $dateTime;
}
} catch (Exception $e) {
return null;
}
if (!is_array($value)) {
return null;
}
$value += [
'year' => null, 'month' => null, 'day' => null,
'hour' => 0, 'minute' => 0, 'second' => 0, 'microsecond' => 0,
];
if (
!is_numeric($value['year']) || !is_numeric($value['month']) || !is_numeric($value['day']) ||
!is_numeric($value['hour']) || !is_numeric($value['minute']) || !is_numeric($value['second']) ||
!is_numeric($value['microsecond'])
) {
return null;
}
if (isset($value['meridian']) && (int)$value['hour'] === 12) {
$value['hour'] = 0;
}
if (isset($value['meridian'])) {
$value['hour'] = strtolower($value['meridian']) === 'am' ? $value['hour'] : $value['hour'] + 12;
}
$format = sprintf(
'%d-%02d-%02d %02d:%02d:%02d.%06d',
$value['year'],
$value['month'],
$value['day'],
$value['hour'],
$value['minute'],
$value['second'],
$value['microsecond']
);
$dateTime = new $class($format, $value['timezone'] ?? $this->userTimezone);
return $dateTime->setTimezone($this->defaultTimezone);
}
/**
* Sets whether to parse strings passed to `marshal()` using
* the locale-aware format set by `setLocaleFormat()`.
*
* @param bool $enable Whether to enable
* @return $this
*/
public function useLocaleParser(bool $enable = true)
{
if ($enable === false) {
$this->_useLocaleMarshal = $enable;
return $this;
}
if (is_a($this->_className, DateTime::class, true)) {
$this->_useLocaleMarshal = $enable;
return $this;
}
throw new DatabaseException(
sprintf('Cannot use locale parsing with the %s class', $this->_className)
);
}
/**
* Sets the locale-aware format used by `marshal()` when parsing strings.
*
* See `Cake\I18n\Time::parseDateTime()` for accepted formats.
*
* @param array|string $format The locale-aware format
* @see \Cake\I18n\Time::parseDateTime()
* @return $this
*/
public function setLocaleFormat(array|string $format)
{
$this->_localeMarshalFormat = $format;
return $this;
}
/**
* Get the classname used for building objects.
*
* @return class-string<\Cake\I18n\DateTime>|class-string<\DateTimeImmutable>
*/
public function getDateTimeClassName(): string
{
return $this->_className;
}
/**
* Converts a string into a DateTime object after parsing it using the locale
* aware parser with the format set by `setLocaleFormat()`.
*
* @param string $value The value to parse and convert to an object.
* @return \Cake\I18n\DateTime|null
*/
protected function _parseLocaleValue(string $value): ?DateTime
{
/** @var class-string<\Cake\I18n\DateTime> $class */
$class = $this->_className;
return $class::parseDateTime($value, $this->_localeMarshalFormat, $this->userTimezone);
}
/**
* Converts a string into a DateTime object after parsing it using the
* formats in `_marshalFormats`.
*
* @param string $value The value to parse and convert to an object.
* @return \Cake\I18n\DateTime|\DateTimeImmutable|null
*/
protected function _parseValue(string $value): DateTime|DateTimeImmutable|null
{
$class = $this->_className;
foreach ($this->_marshalFormats as $format) {
try {
$dateTime = $class::createFromFormat($format, $value, $this->userTimezone);
// Check for false in case DateTimeImmutable is used
if ($dateTime !== false) {
return $dateTime;
}
} catch (InvalidArgumentException) {
// Chronos wraps DateTimeImmutable::createFromFormat and throws
// exception if parse fails.
continue;
}
}
return null;
}
/**
* @inheritDoc
*/
public function toStatement(mixed $value, Driver $driver): int
{
return PDO::PARAM_STR;
}
}