-
Notifications
You must be signed in to change notification settings - Fork 11
/
FormatDateTimeExtension.php
191 lines (165 loc) · 6.32 KB
/
FormatDateTimeExtension.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
<?php
namespace Craue\TwigExtensionsBundle\Twig\Extension;
/**
* Twig extension providing filters for locale-aware formatting of date, time, and date/time values.
*
* @author Christian Raue <christian.raue@gmail.com>
* @copyright 2011-2012 Christian Raue
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
class FormatDateTimeExtension extends AbstractLocaleAwareExtension {
/**
* @var integer
*/
protected $datetype = \IntlDateFormatter::MEDIUM;
/**
* @var integer
*/
protected $timetype = \IntlDateFormatter::MEDIUM;
/**
* @var string
*/
protected $dateFilterAlias = null;
/**
* @var string
*/
protected $timeFilterAlias = null;
/**
* @var string
*/
protected $dateTimeFilterAlias = null;
/**
* @param string $datetype Date format. Valid values are "none", "full", "long", "medium", or "short" (case insensitive).
* @param string $timetype Time format. Valid values are "none", "full", "long", "medium", or "short" (case insensitive).
*/
public function setDateTimeTypes($datetype = null, $timetype = null) {
if ($datetype !== null) {
$this->datetype = $this->getDateFormatterFormat($datetype);
}
if ($timetype !== null) {
$this->timetype = $this->getDateFormatterFormat($timetype);
}
}
/**
* @param string $dateFilterAlias Alias for the date filter.
* @param string $timeFilterAlias Alias for the time filter.
* @param string $dateTimeFilterAlias Alias for the date/time filter.
*/
public function setAliases($dateFilterAlias = null, $timeFilterAlias = null, $dateTimeFilterAlias = null) {
if (!empty($dateFilterAlias)) {
$this->dateFilterAlias = $dateFilterAlias;
}
if (!empty($timeFilterAlias)) {
$this->timeFilterAlias = $timeFilterAlias;
}
if (!empty($dateTimeFilterAlias)) {
$this->dateTimeFilterAlias = $dateTimeFilterAlias;
}
}
/**
* {@inheritDoc}
*/
public function getName() {
return 'craue_formatDateTime';
}
/**
* {@inheritDoc}
*/
public function getFilters() {
$filters = array();
$formatDateMethod = new \Twig_Filter_Method($this, 'formatDate');
$filters['craue_date'] = $formatDateMethod;
if (!empty($this->dateFilterAlias)) {
$filters[$this->dateFilterAlias] = $formatDateMethod;
}
$formatTimeMethod = new \Twig_Filter_Method($this, 'formatTime');
$filters['craue_time'] = $formatTimeMethod;
if (!empty($this->timeFilterAlias)) {
$filters[$this->timeFilterAlias] = $formatTimeMethod;
}
$formatDateTimeMethod = new \Twig_Filter_Method($this, 'formatDateTime');
$filters['craue_datetime'] = $formatDateTimeMethod;
if (!empty($this->dateTimeFilterAlias)) {
$filters[$this->dateTimeFilterAlias] = $formatDateTimeMethod;
}
return $filters;
}
/**
* Formats a timestamp as date.
* @param mixed $value Date value to be formatted.
* @param string $locale Locale to be used with {@link http://php.net/manual/class.intldateformatter.php}.
* @return string Formatted date.
*/
public function formatDate($value, $locale = null) {
return $this->getFormattedDateTime($value, $locale, $this->datetype, \IntlDateFormatter::NONE);
}
/**
* Formats a timestamp as time.
* @param mixed $value Time value to be formatted.
* @param string $locale Locale to be used with {@link http://php.net/manual/class.intldateformatter.php}.
* @return string Formatted time.
*/
public function formatTime($value, $locale = null) {
return $this->getFormattedDateTime($value, $locale, \IntlDateFormatter::NONE, $this->timetype);
}
/**
* Formats a timestamp as date and time.
* @param mixed $value Date/time value to be formatted.
* @param string $locale Locale to be used with {@link http://php.net/manual/class.intldateformatter.php}.
* @return string Formatted date and time.
*/
public function formatDateTime($value, $locale = null) {
return $this->getFormattedDateTime($value, $locale, $this->datetype, $this->timetype);
}
/**
* Formats a date/time value.
* If the value is null also null will be returned.
* @param mixed $value Date/time value to be formatted using {@link http://php.net/manual/intldateformatter.format.php}.
* @param string $locale Locale to be used with {@link http://php.net/manual/class.intldateformatter.php}.
* @param integer $datetype Date format. See {@link http://php.net/manual/class.intldateformatter.php#intl.intldateformatter-constants} for valid values.
* @param integer $timetype Time format. See {@link http://php.net/manual/class.intldateformatter.php#intl.intldateformatter-constants} for valid values.
* @return string Formatted date/time.
* @throws \InvalidArgumentException
*/
protected function getFormattedDateTime($value, $locale, $datetype, $timetype) {
if ($value === null) {
return null;
}
$valueToUse = $value;
// IntlDateFormatter#format() doesn't support \DateTime objects prior to PHP 5.3.4 (http://php.net/manual/intldateformatter.format.php)
if ($valueToUse instanceof \DateTime) {
// \DateTime::getTimestamp() would return false for year > 2038 on 32-bit systems (https://bugs.php.net/bug.php?id=50590)
$valueToUse = floatval($valueToUse->format('U'));
} elseif (is_string($valueToUse)) {
$valueToUse = floatval($valueToUse);
}
$localeToUse = !empty($locale) ? $locale : $this->getLocale();
$formatter = new \IntlDateFormatter($localeToUse, $datetype, $timetype, date_default_timezone_get());
$result = $formatter->format($valueToUse);
if ($result === false) {
throw new \InvalidArgumentException(sprintf('The value "%s" of type %s cannot be formatted. Error: "%s".', $value, gettype($value), $formatter->getErrorMessage()));
}
return $result;
}
/**
* @param string $format Date/time format. Valid values are "none", "full", "long", "medium", or "short" (case insensitive).
* @return integer Appropriate value of {@link http://php.net/manual/class.intldateformatter.php#intl.intldateformatter-constants}.
* @throws \InvalidArgumentException
*/
protected function getDateFormatterFormat($format) {
switch (strtoupper($format)) {
case 'NONE':
return \IntlDateFormatter::NONE;
case 'FULL':
return \IntlDateFormatter::FULL;
case 'LONG':
return \IntlDateFormatter::LONG;
case 'MEDIUM':
return \IntlDateFormatter::MEDIUM;
case 'SHORT':
return \IntlDateFormatter::SHORT;
default:
throw new \InvalidArgumentException(sprintf('A value of "%s" is not supported.', $format));
}
}
}