3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Util;
24 use Friendica\Core\Logger;
34 const ATOM = 'Y-m-d\TH:i:s\Z';
35 const MYSQL = 'Y-m-d H:i:s';
36 const HTTP = 'D, d M Y H:i:s \G\M\T';
37 const JSON = 'Y-m-d\TH:i:s.v\Z';
38 const API = 'D M d H:i:s +0000 Y';
40 static $localTimezone = 'UTC';
42 public static function setLocalTimeZone(string $timezone)
44 self::$localTimezone = $timezone;
48 * convert() shorthand for UTC.
50 * @param string $time A date/time string
51 * @param string $format DateTime format string or Temporal constant
55 public static function utc($time, $format = self::MYSQL)
57 return self::convert($time, 'UTC', 'UTC', $format);
61 * convert() shorthand for local.
63 * @param string $time A date/time string
64 * @param string $format DateTime format string or Temporal constant
68 public static function local($time, $format = self::MYSQL)
70 return self::convert($time, self::$localTimezone, 'UTC', $format);
74 * convert() shorthand for timezoned now.
77 * @param string $format DateTime format string or Temporal constant
81 public static function timezoneNow($timezone, $format = self::MYSQL)
83 return self::convert('now', $timezone, 'UTC', $format);
87 * convert() shorthand for local now.
89 * @param string $format DateTime format string or Temporal constant
93 public static function localNow($format = self::MYSQL)
95 return self::local('now', $format);
99 * convert() shorthand for UTC now.
101 * @param string $format DateTime format string or Temporal constant
105 public static function utcNow($format = self::MYSQL)
107 return self::utc('now', $format);
111 * General purpose date parse/convert/format function.
113 * @param string $s Some parseable date/time string
114 * @param string $tz_to Destination timezone
115 * @param string $tz_from Source timezone
116 * @param string $format Output format recognised from php's DateTime class
117 * http://www.php.net/manual/en/datetime.format.php
119 * @return string Formatted date according to given format
122 public static function convert($s = 'now', $tz_to = 'UTC', $tz_from = 'UTC', $format = self::MYSQL)
124 // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
125 // Provide some sane defaults regardless.
126 if ($tz_from === '') {
134 if (($s === '') || (!is_string($s))) {
139 * Slight hackish adjustment so that 'zero' datetime actually returns what is intended
140 * otherwise we end up with -0001-11-30 ...
141 * add 32 days so that we at least get year 00, and then hack around the fact that
142 * months and days always start with 1.
144 if (substr($s, 0, 10) <= '0001-01-01') {
145 if ($s < '0000-00-00') {
148 $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC'));
149 return str_replace('1', '0', $d->format($format));
153 $from_obj = new DateTimeZone($tz_from);
154 } catch (Exception $e) {
155 $from_obj = new DateTimeZone('UTC');
159 $d = new DateTime($s, $from_obj);
160 } catch (Exception $e) {
161 Logger::notice('DateTimeFormat::convert: exception: ' . $e->getMessage());
162 $d = new DateTime('now', $from_obj);
166 $to_obj = new DateTimeZone($tz_to);
167 } catch (Exception $e) {
168 $to_obj = new DateTimeZone('UTC');
171 $d->setTimezone($to_obj);
173 return $d->format($format);
177 * Checks, if the given string is a date with the pattern YYYY-MM
179 * @param string $dateString The given date
181 * @return boolean True, if the date is a valid pattern
183 public function isYearMonth(string $dateString)
185 // Check format (2019-01, 2019-1, 2019-10)
186 if (!preg_match('/^([12]\d{3}-(1[0-2]|0[1-9]|\d))$/', $dateString)) {
190 $date = DateTime::createFromFormat('Y-m', $dateString);
197 $now = new DateTime();
198 } catch (\Throwable $t) {
210 * Checks, if the given string is a date with the pattern YYYY-MM-DD
212 * @param string $dateString The given date
214 * @return boolean True, if the date is a valid pattern
216 public function isYearMonthDay(string $dateString)
218 $date = DateTime::createFromFormat('Y-m-d', $dateString);
223 if (DateTime::getLastErrors()['error_count'] || DateTime::getLastErrors()['warning_count']) {