-
Notifications
You must be signed in to change notification settings - Fork 7
/
FrozenDate.php
178 lines (167 loc) · 7.01 KB
/
FrozenDate.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
<?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.2.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\I18n;
use Cake\Chronos\Date as ChronosDate;
use IntlDateFormatter;
/**
* Extends the Date class provided by Chronos.
*
* Adds handy methods and locale-aware formatting helpers
*
* This object provides an immutable variant of Cake\I18n\Date
*/
class FrozenDate extends ChronosDate implements I18nDateTimeInterface
{
use DateFormatTrait;
/**
* The format to use when formatting a time using `Cake\I18n\Date::i18nFormat()`
* and `__toString`. This format is also used by `parseDateTime()`.
*
* The format should be either the formatting constants from IntlDateFormatter as
* described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern
* as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
*
* It is possible to provide an array of 2 constants. In this case, the first position
* will be used for formatting the date part of the object and the second position
* will be used to format the time part.
*
* @var string|int|int[]
* @see \Cake\I18n\DateFormatTrait::i18nFormat()
*/
protected static $_toStringFormat = [IntlDateFormatter::SHORT, -1];
/**
* The format to use when converting this object to JSON.
*
* The format should be either the formatting constants from IntlDateFormatter as
* described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern
* as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
*
* It is possible to provide an array of 2 constants. In this case, the first position
* will be used for formatting the date part of the object and the second position
* will be used to format the time part.
*
* @var string|int|int[]|\Closure
* @see \Cake\I18n\Time::i18nFormat()
*/
protected static $_jsonEncodeFormat = 'yyyy-MM-dd';
/**
* The format to use when formatting a time using `Cake\I18n\Date::timeAgoInWords()`
* and the difference is more than `Cake\I18n\Date::$wordEnd`
*
* @var string|int|int[]
* @see \Cake\I18n\DateFormatTrait::parseDate()
*/
public static $wordFormat = [IntlDateFormatter::SHORT, IntlDateFormatter::NONE];
/**
* The format to use when formatting a time using `Cake\I18n\Date::nice()`
*
* The format should be either the formatting constants from IntlDateFormatter as
* described in (https://secure.php.net/manual/en/class.intldateformatter.php) or a pattern
* as specified in (http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details)
*
* It is possible to provide an array of 2 constants. In this case, the first position
* will be used for formatting the date part of the object and the second position
* will be used to format the time part.
*
* @var string|int|int[]
* @see \Cake\I18n\DateFormatTrait::nice()
*/
public static $niceFormat = [IntlDateFormatter::MEDIUM, IntlDateFormatter::NONE];
/**
* The format to use when formatting a time using `Date::timeAgoInWords()`
* and the difference is less than `Date::$wordEnd`
*
* @var string[]
* @see \Cake\I18n\Date::timeAgoInWords()
*/
public static $wordAccuracy = [
'year' => 'day',
'month' => 'day',
'week' => 'day',
'day' => 'day',
'hour' => 'day',
'minute' => 'day',
'second' => 'day',
];
/**
* The end of relative time telling
*
* @var string
* @see \Cake\I18n\Date::timeAgoInWords()
*/
public static $wordEnd = '+1 month';
/**
* Create a new Date instance.
*
* You can specify the timezone for the $time parameter. This timezone will
* not be used in any future modifications to the Date instance.
*
* The `$timezone` parameter is ignored if `$time` is a DateTimeInterface
* instance.
*
* Date instances lack time components, however due to limitations in PHP's
* internal Datetime object the time will always be set to 00:00:00, and the
* timezone will always be the server local time. Normalizing the timezone allows for
* subtraction/addition to have deterministic results.
*
* @param string|int|\DateTime|\DateTimeImmutable|null $time Fixed or relative time
* @param \DateTimeZone|string|null $tz The timezone in which the date is taken.
* Ignored if `$time` is a DateTimeInterface instance.
*/
public function __construct($time = 'now', $tz = null)
{
parent::__construct($time, $tz);
}
/**
* Returns either a relative or a formatted absolute date depending
* on the difference between the current date and this object.
*
* ### Options:
*
* - `from` => another Date object representing the "now" date
* - `format` => a fall back format if the relative time is longer than the duration specified by end
* - `accuracy` => Specifies how accurate the date should be described (array)
* - year => The format if years > 0 (default "day")
* - month => The format if months > 0 (default "day")
* - week => The format if weeks > 0 (default "day")
* - day => The format if weeks > 0 (default "day")
* - `end` => The end of relative date telling
* - `relativeString` => The printf compatible string when outputting relative date
* - `absoluteString` => The printf compatible string when outputting absolute date
* - `timezone` => The user timezone the timestamp should be formatted in.
*
* Relative dates look something like this:
*
* - 3 weeks, 4 days ago
* - 1 day ago
*
* Default date formatting is d/M/YY e.g: on 18/2/09. Formatting is done internally using
* `i18nFormat`, see the method for the valid formatting strings.
*
* The returned string includes 'ago' or 'on' and assumes you'll properly add a word
* like 'Posted ' before the function output.
*
* NOTE: If the difference is one week or more, the lowest level of accuracy is day.
*
* @param array $options Array of options.
* @return string Relative time string.
*/
public function timeAgoInWords(array $options = []): string
{
/** @psalm-suppress UndefinedInterfaceMethod */
return static::getDiffFormatter()->dateAgoInWords($this, $options);
}
}