[CLEANUP] Replace strlen() with === for zero length check
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Property / TypeConverter / DateTimeConverter.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Property\TypeConverter;
3
4 /* *
5 * This script belongs to the Extbase framework *
6 * *
7 * It is free software; you can redistribute it and/or modify it under *
8 * the terms of the GNU Lesser General Public License as published by the *
9 * Free Software Foundation, either version 3 of the License, or (at your *
10 * option) any later version. *
11 * *
12 * This script is distributed in the hope that it will be useful, but *
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- *
14 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *
15 * General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU Lesser General Public *
18 * License along with the script. *
19 * If not, see http://www.gnu.org/licenses/lgpl.html *
20 * *
21 * The TYPO3 project - inspiring people to share! *
22 * */
23 /**
24 * Converter which transforms from different input formats into DateTime objects.
25 *
26 * Source can be either a string or an array. The date string is expected to be formatted
27 * according to DEFAULT_DATE_FORMAT.
28 *
29 * But the default date format can be overridden in the initialize*Action() method like this::
30 *
31 * $this->arguments['<argumentName>']
32 * ->getPropertyMappingConfiguration()
33 * ->forProperty('<propertyName>') // this line can be skipped in order to specify the format for all properties
34 * ->setTypeConverterOption(\TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::class, \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT, '<dateFormat>');
35 *
36 * If the source is of type array, it is possible to override the format in the source::
37 *
38 * array(
39 * 'date' => '<dateString>',
40 * 'dateFormat' => '<dateFormat>'
41 * );
42 *
43 * By using an array as source you can also override time and timezone of the created DateTime object::
44 *
45 * array(
46 * 'date' => '<dateString>',
47 * 'hour' => '<hour>', // integer
48 * 'minute' => '<minute>', // integer
49 * 'seconds' => '<seconds>', // integer
50 * 'timezone' => '<timezone>', // string, see http://www.php.net/manual/timezones.php
51 * );
52 *
53 * As an alternative to providing the date as string, you might supply day, month and year as array items each::
54 *
55 * array(
56 * 'day' => '<day>', // integer
57 * 'month' => '<month>', // integer
58 * 'year' => '<year>', // integer
59 * );
60 *
61 * @api
62 */
63 class DateTimeConverter extends \TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter {
64
65 /**
66 * @var string
67 */
68 const CONFIGURATION_DATE_FORMAT = 'dateFormat';
69
70 /**
71 * The default date format is "YYYY-MM-DDT##:##:##+##:##", for example "2005-08-15T15:52:01+00:00"
72 * according to the W3C standard @see http://www.w3.org/TR/NOTE-datetime.html
73 *
74 * @var string
75 */
76 const DEFAULT_DATE_FORMAT = \DateTime::W3C;
77
78 /**
79 * @var array<string>
80 */
81 protected $sourceTypes = array('string', 'integer', 'array');
82
83 /**
84 * @var string
85 */
86 protected $targetType = 'DateTime';
87
88 /**
89 * @var int
90 */
91 protected $priority = 1;
92
93 /**
94 * If conversion is possible.
95 *
96 * @param string $source
97 * @param string $targetType
98 * @return bool
99 */
100 public function canConvertFrom($source, $targetType) {
101 if (!is_callable(array($targetType, 'createFromFormat'))) {
102 return FALSE;
103 }
104 if (is_array($source)) {
105 return TRUE;
106 }
107 if (is_integer($source)) {
108 return TRUE;
109 }
110 return is_string($source);
111 }
112
113 /**
114 * Converts $source to a \DateTime using the configured dateFormat
115 *
116 * @param string|int|array $source the string to be converted to a \DateTime object
117 * @param string $targetType must be "DateTime"
118 * @param array $convertedChildProperties not used currently
119 * @param \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration
120 * @return \DateTime
121 * @throws \TYPO3\CMS\Extbase\Property\Exception\TypeConverterException
122 */
123 public function convertFrom($source, $targetType, array $convertedChildProperties = array(), \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration = NULL) {
124 $dateFormat = $this->getDefaultDateFormat($configuration);
125 if (is_string($source)) {
126 $dateAsString = $source;
127 } elseif (is_integer($source)) {
128 $dateAsString = strval($source);
129 } else {
130 if (isset($source['date']) && is_string($source['date'])) {
131 $dateAsString = $source['date'];
132 } elseif (isset($source['date']) && is_integer($source['date'])) {
133 $dateAsString = strval($source['date']);
134 } elseif ($this->isDatePartKeysProvided($source)) {
135 if ($source['day'] < 1 || $source['month'] < 1 || $source['year'] < 1) {
136 return new \TYPO3\CMS\Extbase\Error\Error('Could not convert the given date parts into a DateTime object because one or more parts were 0.', 1333032779);
137 }
138 $dateAsString = sprintf('%d-%d-%d', $source['year'], $source['month'], $source['day']);
139 } else {
140 throw new \TYPO3\CMS\Extbase\Property\Exception\TypeConverterException('Could not convert the given source into a DateTime object because it was not an array with a valid date as a string', 1308003914);
141 }
142 if (isset($source['dateFormat']) && $source['dateFormat'] !== '') {
143 $dateFormat = $source['dateFormat'];
144 }
145 }
146 if ($dateAsString === '') {
147 return NULL;
148 }
149 if (ctype_digit($dateAsString) && $configuration === NULL && (!is_array($source) || !isset($source['dateFormat']))) {
150 $dateFormat = 'U';
151 }
152 if (is_array($source) && isset($source['timezone']) && (string)$source['timezone'] !== '') {
153 try {
154 $timezone = new \DateTimeZone($source['timezone']);
155 } catch (\Exception $e) {
156 throw new \TYPO3\CMS\Extbase\Property\Exception\TypeConverterException('The specified timezone "' . $source['timezone'] . '" is invalid.', 1308240974);
157 }
158 $date = $targetType::createFromFormat($dateFormat, $dateAsString, $timezone);
159 } else {
160 $date = $targetType::createFromFormat($dateFormat, $dateAsString);
161 }
162 if ($date === FALSE) {
163 return new \TYPO3\CMS\Extbase\Validation\Error('The date "%s" was not recognized (for format "%s").', 1307719788, array($dateAsString, $dateFormat));
164 }
165 if (is_array($source)) {
166 $this->overrideTimeIfSpecified($date, $source);
167 }
168 return $date;
169 }
170
171 /**
172 * Returns whether date information (day, month, year) are present as keys in $source.
173 *
174 * @param array $source
175 * @return bool
176 */
177 protected function isDatePartKeysProvided(array $source) {
178 return isset($source['day']) && ctype_digit($source['day'])
179 && isset($source['month']) && ctype_digit($source['month'])
180 && isset($source['year']) && ctype_digit($source['year']);
181 }
182
183 /**
184 * Determines the default date format to use for the conversion.
185 * If no format is specified in the mapping configuration DEFAULT_DATE_FORMAT is used.
186 *
187 * @param \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration
188 * @return string
189 * @throws \TYPO3\CMS\Extbase\Property\Exception\InvalidPropertyMappingConfigurationException
190 */
191 protected function getDefaultDateFormat(\TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration = NULL) {
192 if ($configuration === NULL) {
193 return self::DEFAULT_DATE_FORMAT;
194 }
195 $dateFormat = $configuration->getConfigurationValue(\TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::class, self::CONFIGURATION_DATE_FORMAT);
196 if ($dateFormat === NULL) {
197 return self::DEFAULT_DATE_FORMAT;
198 } elseif ($dateFormat !== NULL && !is_string($dateFormat)) {
199 throw new \TYPO3\CMS\Extbase\Property\Exception\InvalidPropertyMappingConfigurationException('CONFIGURATION_DATE_FORMAT must be of type string, "' . (is_object($dateFormat) ? get_class($dateFormat) : gettype($dateFormat)) . '" given', 1307719569);
200 }
201 return $dateFormat;
202 }
203
204 /**
205 * Overrides hour, minute & second of the given date with the values in the $source array
206 *
207 * @param \DateTime $date
208 * @param array $source
209 * @return void
210 */
211 protected function overrideTimeIfSpecified(\DateTime $date, array $source) {
212 if (!isset($source['hour']) && !isset($source['minute']) && !isset($source['second'])) {
213 return;
214 }
215 $hour = isset($source['hour']) ? (int)$source['hour'] : 0;
216 $minute = isset($source['minute']) ? (int)$source['minute'] : 0;
217 $second = isset($source['second']) ? (int)$source['second'] : 0;
218 $date->setTime($hour, $minute, $second);
219 }
220
221 }