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
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC;
class DateTimeFormatter implements \OCP\IDateTimeFormatter {
/** @var \DateTimeZone */
protected $defaultTimeZone;
/** @var \OCP\IL10N */
protected $defaultL10N;
/**
* Constructor
*
* @param \DateTimeZone $defaultTimeZone Set the timezone for the format
* @param \OCP\IL10N $defaultL10N Set the language for the format
*/
public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
$this->defaultTimeZone = $defaultTimeZone;
$this->defaultL10N = $defaultL10N;
}
/**
* Get TimeZone to use
*
* @param \DateTimeZone $timeZone The timezone to use
* @return \DateTimeZone The timezone to use, falling back to the current user's timezone
*/
protected function getTimeZone($timeZone = null) {
if ($timeZone === null) {
$timeZone = $this->defaultTimeZone;
}
return $timeZone;
}
/**
* Get \OCP\IL10N to use
*
* @param \OCP\IL10N $l The locale to use
* @return \OCP\IL10N The locale to use, falling back to the current user's locale
*/
protected function getLocale($l = null) {
if ($l === null) {
$l = $this->defaultL10N;
}
return $l;
}
/**
* Generates a DateTime object with the given timestamp and TimeZone
*
* @param mixed $timestamp
* @param \DateTimeZone $timeZone The timezone to use
* @return \DateTime
*/
protected function getDateTime($timestamp, ?\DateTimeZone $timeZone = null) {
if ($timestamp === null) {
return new \DateTime('now', $timeZone);
} elseif (!$timestamp instanceof \DateTime) {
$dateTime = new \DateTime('now', $timeZone);
$dateTime->setTimestamp($timestamp);
return $dateTime;
}
if ($timeZone) {
$timestamp->setTimezone($timeZone);
}
return $timestamp;
}
/**
* Formats the date of the given timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param string $format Either 'full', 'long', 'medium' or 'short'
* full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014'
* long: e.g. 'MMMM d, y' => 'August 20, 2014'
* medium: e.g. 'MMM d, y' => 'Aug 20, 2014'
* short: e.g. 'M/d/yy' => '8/20/14'
* The exact format is dependent on the language
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date string
*/
public function formatDate($timestamp, $format = 'long', ?\DateTimeZone $timeZone = null, ?\OCP\IL10N $l = null) {
return $this->format($timestamp, 'date', $format, $timeZone, $l);
}
/**
* Formats the date of the given timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param string $format Either 'full', 'long', 'medium' or 'short'
* full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014'
* long: e.g. 'MMMM d, y' => 'August 20, 2014'
* medium: e.g. 'MMM d, y' => 'Aug 20, 2014'
* short: e.g. 'M/d/yy' => '8/20/14'
* The exact format is dependent on the language
* Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted relative date string
*/
public function formatDateRelativeDay($timestamp, $format = 'long', ?\DateTimeZone $timeZone = null, ?\OCP\IL10N $l = null) {
if (!str_ends_with($format, '^') && !str_ends_with($format, '*')) {
$format .= '^';
}
return $this->format($timestamp, 'date', $format, $timeZone, $l);
}
/**
* Gives the relative date of the timestamp
* Only works for past dates
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date span. Dates returned are:
* < 1 month => Today, Yesterday, n days ago
* < 13 month => last month, n months ago
* >= 13 month => last year, n years ago
*/
public function formatDateSpan($timestamp, $baseTimestamp = null, ?\OCP\IL10N $l = null) {
$l = $this->getLocale($l);
$timestamp = $this->getDateTime($timestamp);
$timestamp->setTime(0, 0, 0);
if ($baseTimestamp === null) {
$baseTimestamp = time();
}
$baseTimestamp = $this->getDateTime($baseTimestamp);
$baseTimestamp->setTime(0, 0, 0);
$dateInterval = $timestamp->diff($baseTimestamp);
if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
return $l->t('today');
} elseif ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
if ($timestamp > $baseTimestamp) {
return $l->t('tomorrow');
} else {
return $l->t('yesterday');
}
} elseif ($dateInterval->y == 0 && $dateInterval->m == 0) {
if ($timestamp > $baseTimestamp) {
return $l->n('in %n day', 'in %n days', $dateInterval->d);
} else {
return $l->n('%n day ago', '%n days ago', $dateInterval->d);
}
} elseif ($dateInterval->y == 0 && $dateInterval->m == 1) {
if ($timestamp > $baseTimestamp) {
return $l->t('next month');
} else {
return $l->t('last month');
}
} elseif ($dateInterval->y == 0) {
if ($timestamp > $baseTimestamp) {
return $l->n('in %n month', 'in %n months', $dateInterval->m);
} else {
return $l->n('%n month ago', '%n months ago', $dateInterval->m);
}
} elseif ($dateInterval->y == 1) {
if ($timestamp > $baseTimestamp) {
return $l->t('next year');
} else {
return $l->t('last year');
}
}
if ($timestamp > $baseTimestamp) {
return $l->n('in %n year', 'in %n years', $dateInterval->y);
} else {
return $l->n('%n year ago', '%n years ago', $dateInterval->y);
}
}
/**
* Formats the time of the given timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param string $format Either 'full', 'long', 'medium' or 'short'
* full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00'
* long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT'
* medium: e.g. 'h:mm:ss a' => '11:42:13 AM'
* short: e.g. 'h:mm a' => '11:42 AM'
* The exact format is dependent on the language
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted time string
*/
public function formatTime($timestamp, $format = 'medium', ?\DateTimeZone $timeZone = null, ?\OCP\IL10N $l = null) {
return $this->format($timestamp, 'time', $format, $timeZone, $l);
}
/**
* Gives the relative past time of the timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time
* @param \OCP\IL10N $l The locale to use
* @return string Formatted time span. Dates returned are:
* < 60 sec => seconds ago
* < 1 hour => n minutes ago
* < 1 day => n hours ago
* < 1 month => Yesterday, n days ago
* < 13 month => last month, n months ago
* >= 13 month => last year, n years ago
*/
public function formatTimeSpan($timestamp, $baseTimestamp = null, ?\OCP\IL10N $l = null) {
$l = $this->getLocale($l);
$timestamp = $this->getDateTime($timestamp);
if ($baseTimestamp === null) {
$baseTimestamp = time();
}
$baseTimestamp = $this->getDateTime($baseTimestamp);
$diff = $timestamp->diff($baseTimestamp);
if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
return $this->formatDateSpan($timestamp, $baseTimestamp, $l);
}
if ($diff->h > 0) {
if ($timestamp > $baseTimestamp) {
return $l->n('in %n hour', 'in %n hours', $diff->h);
} else {
return $l->n('%n hour ago', '%n hours ago', $diff->h);
}
} elseif ($diff->i > 0) {
if ($timestamp > $baseTimestamp) {
return $l->n('in %n minute', 'in %n minutes', $diff->i);
} else {
return $l->n('%n minute ago', '%n minutes ago', $diff->i);
}
}
if ($timestamp > $baseTimestamp) {
return $l->t('in a few seconds');
} else {
return $l->t('seconds ago');
}
}
/**
* Formats the date and time of the given timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param string $formatDate See formatDate() for description
* @param string $formatTime See formatTime() for description
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date and time string
*/
public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', ?\DateTimeZone $timeZone = null, ?\OCP\IL10N $l = null) {
return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
}
/**
* Formats the date and time of the given timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param string $formatDate See formatDate() for description
* Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
* @param string $formatTime See formatTime() for description
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted relative date and time string
*/
public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', ?\DateTimeZone $timeZone = null, ?\OCP\IL10N $l = null) {
if (!str_ends_with($formatDate, '^') && !str_ends_with($formatDate, '*')) {
$formatDate .= '^';
}
return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
}
/**
* Formats the date and time of the given timestamp
*
* @param int|\DateTime $timestamp Either a Unix timestamp or DateTime object
* @param string $type One of 'date', 'datetime' or 'time'
* @param string $format Format string
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date and time string
*/
protected function format($timestamp, $type, $format, ?\DateTimeZone $timeZone = null, ?\OCP\IL10N $l = null) {
$l = $this->getLocale($l);
$timeZone = $this->getTimeZone($timeZone);
$timestamp = $this->getDateTime($timestamp, $timeZone);
return $l->l($type, $timestamp, [
'width' => $format,
]);
}
}
|
