4 * @file src/Util/Temporal.php
7 namespace Friendica\Util;
11 use Friendica\Core\Renderer;
12 use Friendica\Database\DBA;
21 * Two-level sort for timezones.
27 private static function timezoneCompareCallback($a, $b)
29 if (strstr($a, '/') && strstr($b, '/')) {
30 if (DI::l10n()->t($a) == DI::l10n()->t($b)) {
33 return (DI::l10n()->t($a) < DI::l10n()->t($b)) ? -1 : 1;
36 if (strstr($a, '/')) {
38 } elseif (strstr($b, '/')) {
40 } elseif (DI::l10n()->t($a) == DI::l10n()->t($b)) {
44 return (DI::l10n()->t($a) < DI::l10n()->t($b)) ? -1 : 1;
48 * Emit a timezone selector grouped (primarily) by continent
50 * @param string $current Timezone
51 * @return string Parsed HTML output
53 public static function getTimezoneSelect($current = 'America/Los_Angeles')
55 $timezone_identifiers = DateTimeZone::listIdentifiers();
57 $o = '<select id="timezone_select" name="timezone">';
59 usort($timezone_identifiers, [__CLASS__, 'timezoneCompareCallback']);
61 foreach ($timezone_identifiers as $value) {
62 $ex = explode("/", $value);
64 if ($ex[0] != $continent) {
65 if ($continent != '') {
69 $o .= '<optgroup label="' . DI::l10n()->t($continent) . '">';
72 $city = substr($value, strpos($value, '/') + 1);
78 if ($continent != DI::l10n()->t('Miscellaneous')) {
80 $continent = DI::l10n()->t('Miscellaneous');
81 $o .= '<optgroup label="' . DI::l10n()->t($continent) . '">';
84 $city = str_replace('_', ' ', DI::l10n()->t($city));
85 $selected = (($value == $current) ? " selected=\"selected\" " : "");
86 $o .= "<option value=\"$value\" $selected >$city</option>";
88 $o .= '</optgroup></select>';
93 * Generating a Timezone selector
95 * Return a select using 'field_select_raw' template, with timezones
96 * grouped (primarily) by continent
97 * arguments follow convention as other field_* template array:
98 * 'name', 'label', $value, 'help'
100 * @param string $name Name of the selector
101 * @param string $label Label for the selector
102 * @param string $current Timezone
103 * @param string $help Help text
105 * @return string Parsed HTML
106 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
108 public static function getTimezoneField($name = 'timezone', $label = '', $current = 'America/Los_Angeles', $help = '')
110 $options = self::getTimezoneSelect($current);
111 $options = str_replace('<select id="timezone_select" name="timezone">', '', $options);
112 $options = str_replace('</select>', '', $options);
114 $tpl = Renderer::getMarkupTemplate('field_select_raw.tpl');
115 return Renderer::replaceMacros($tpl, [
116 '$field' => [$name, $label, $current, $help, $options],
121 * Wrapper for date selector, tailored for use in birthday fields.
123 * @param string $dob Date of Birth
124 * @param string $timezone
125 * @return string Formatted HTML
128 public static function getDateofBirthField(string $dob, string $timezone = 'UTC')
130 list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d');
132 if ($dob < '0000-01-01') {
135 $value = DateTimeFormat::utc(($year > 1000) ? $dob : '1000-' . $month . '-' . $day, 'Y-m-d');
138 $age = (intval($value) ? self::getAgeByTimezone($value, $timezone, $timezone) : "");
140 $tpl = Renderer::getMarkupTemplate("field_input.tpl");
141 $o = Renderer::replaceMacros($tpl,
145 DI::l10n()->t('Birthday:'),
147 intval($age) > 0 ? DI::l10n()->t('Age: ') . $age : "",
149 'placeholder="' . DI::l10n()->t('YYYY-MM-DD or MM-DD') . '"'
157 * Returns a date selector
159 * @param DateTime $min Minimum date
160 * @param DateTime $max Maximum date
161 * @param DateTime $default Default date
162 * @param string $id ID and name of datetimepicker (defaults to "datetimepicker")
164 * @return string Parsed HTML output.
165 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
167 public static function getDateField($min, $max, $default, $id = 'datepicker')
169 return self::getDateTimeField($min, $max, $default, '', $id, true, false, '', '');
173 * Returns a time selector
175 * @param string $h Already selected hour
176 * @param string $m Already selected minute
177 * @param string $id ID and name of datetimepicker (defaults to "timepicker")
179 * @return string Parsed HTML output.
182 public static function getTimeField($h, $m, $id = 'timepicker')
184 return self::getDateTimeField(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
188 * Returns a datetime selector.
190 * @param DateTime $minDate Minimum date
191 * @param DateTime $maxDate Maximum date
192 * @param DateTime $defaultDate Default date
194 * @param string $id Id and name of datetimepicker (defaults to "datetimepicker")
195 * @param bool $pickdate true to show date picker (default)
196 * @param bool $picktime true to show time picker (default)
197 * @param string $minfrom set minimum date from picker with id $minfrom (none by default)
198 * @param string $maxfrom set maximum date from picker with id $maxfrom (none by default)
199 * @param bool $required default false
201 * @return string Parsed HTML output.
203 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
204 * @todo Once browser support is better this could probably be replaced with
205 * native HTML5 date picker.
207 public static function getDateTimeField(
210 DateTime $defaultDate,
212 $id = 'datetimepicker',
219 // First day of the week (0 = Sunday)
220 $firstDay = DI::pConfig()->get(local_user(), 'system', 'first_day_of_week', 0);
222 $lang = substr(DI::l10n()->getCurrentLang(), 0, 2);
224 // Check if the detected language is supported by the picker
226 ["ar", "ro", "id", "bg", "fa", "ru", "uk", "en", "el", "de", "nl", "tr", "fr", "es", "th", "pl", "pt", "ch", "se", "kr",
227 "it", "da", "no", "ja", "vi", "sl", "cs", "hu"])) {
235 $dateformat .= 'Y-m-d';
238 if ($pickdate && $picktime) {
243 $dateformat .= 'H:i';
246 $input_text = $defaultDate ? date($dateformat, $defaultDate->getTimestamp()) : '';
248 $readable_format = str_replace(['Y', 'm', 'd', 'H', 'i'], ['yyyy', 'mm', 'dd', 'HH', 'MM'], $dateformat);
250 $tpl = Renderer::getMarkupTemplate('field_datetime.tpl');
251 $o .= Renderer::replaceMacros($tpl, [
257 $required ? '*' : '',
258 'placeholder="' . $readable_format . '"'
260 '$datetimepicker' => [
261 'minDate' => $minDate,
262 'maxDate' => $maxDate,
263 'defaultDate' => $defaultDate,
264 'dateformat' => $dateformat,
265 'firstDay' => $firstDay,
267 'minfrom' => $minfrom,
268 'maxfrom' => $maxfrom,
276 * Returns a relative date string.
278 * Implements "3 seconds ago" etc.
279 * Based on $posted_date, (UTC).
280 * Results relative to current timezone.
281 * Limited to range of timestamps.
283 * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
284 * @param string $format (optional) Parsed with sprintf()
285 * <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
287 * @return string with relative date
289 public static function getRelativeDate($posted_date, $format = null)
291 $localtime = $posted_date . ' UTC';
293 $abs = strtotime($localtime);
295 if (is_null($posted_date) || $posted_date <= DBA::NULL_DATETIME || $abs === false) {
296 return DI::l10n()->t('never');
300 $etime = time() - $abs;
302 if ($etime < 1 && $etime >= 0) {
303 return DI::l10n()->t('less than a second ago');
311 $a = [12 * 30 * 24 * 60 * 60 => [DI::l10n()->t('year'), DI::l10n()->t('years')],
312 30 * 24 * 60 * 60 => [DI::l10n()->t('month'), DI::l10n()->t('months')],
313 7 * 24 * 60 * 60 => [DI::l10n()->t('week'), DI::l10n()->t('weeks')],
314 24 * 60 * 60 => [DI::l10n()->t('day'), DI::l10n()->t('days')],
315 60 * 60 => [DI::l10n()->t('hour'), DI::l10n()->t('hours')],
316 60 => [DI::l10n()->t('minute'), DI::l10n()->t('minutes')],
317 1 => [DI::l10n()->t('second'), DI::l10n()->t('seconds')]
320 foreach ($a as $secs => $str) {
324 // translators - e.g. 22 hours ago, 1 minute ago
327 $format = DI::l10n()->t('in %1$d %2$s');
330 $format = DI::l10n()->t('%1$d %2$s ago');
334 return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
340 * Returns timezone correct age in years.
342 * Returns the age in years, given a date of birth, the timezone of the person
343 * whose date of birth is provided, and the timezone of the person viewing the
346 * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
347 * is on New Year's. You live in San Bruno, California.
348 * When exactly are you going to see my age increase?
350 * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
351 * and become a year older. If you wish me happy birthday on January 1
352 * (San Bruno time), you'll be a day late.
354 * @param string $dob Date of Birth
355 * @param string $owner_tz (optional) Timezone of the person of interest
356 * @param string $viewer_tz (optional) Timezone of the person viewing
358 * @return int Age in years
361 public static function getAgeByTimezone($dob, $owner_tz = '', $viewer_tz = '')
367 $owner_tz = date_default_timezone_get();
370 $viewer_tz = date_default_timezone_get();
373 $birthdate = DateTimeFormat::convert($dob . ' 00:00:00+00:00', $owner_tz, 'UTC', 'Y-m-d');
374 list($year, $month, $day) = explode("-", $birthdate);
375 $year_diff = DateTimeFormat::timezoneNow($viewer_tz, 'Y') - $year;
376 $curr_month = DateTimeFormat::timezoneNow($viewer_tz, 'm');
377 $curr_day = DateTimeFormat::timezoneNow($viewer_tz, 'd');
379 if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
387 * Get days of a month in a given year.
389 * Returns number of days in the month of the given year.
390 * $m = 1 is 'January' to match human usage.
393 * @param int $m Month (1=January, 12=December)
395 * @return int Number of days in the given month
397 public static function getDaysInMonth($y, $m)
399 return date('t', mktime(0, 0, 0, $m, 1, $y));
403 * Returns the first day in month for a given month, year.
408 * @param int $m Month (1=January, 12=December)
410 * @return string day 0 = Sunday through 6 = Saturday
413 private static function getFirstDayInMonth($y, $m)
415 $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
417 return DateTimeFormat::utc($d, 'w');
421 * Output a calendar for the given month, year.
423 * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
424 * date 12 will be linked appropriately. Today's date is also noted by
426 * Months count from 1.
429 * @param int $m Month
430 * @param array $links (default null)
431 * @param string $class
436 * @todo Provide (prev, next) links, define class variations for different size calendars
438 public static function getCalendarTable($y = 0, $m = 0, $links = null, $class = '')
440 // month table - start at 1 to match human usage.
442 'January', 'February', 'March',
443 'April', 'May', 'June',
444 'July', 'August', 'September',
445 'October', 'November', 'December'
448 $thisyear = DateTimeFormat::localNow('Y');
449 $thismonth = DateTimeFormat::localNow('m');
455 $m = intval($thismonth);
458 $dn = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
459 $f = self::getFirstDayInMonth($y, $m);
460 $l = self::getDaysInMonth($y, $m);
465 if (($y == $thisyear) && ($m == $thismonth)) {
466 $tddate = intval(DateTimeFormat::localNow('j'));
469 $str_month = DI::l10n()->getDay($mtab[$m]);
470 $o = '<table class="calendar' . $class . '">';
471 $o .= "<caption>$str_month $y</caption><tr>";
472 for ($a = 0; $a < 7; $a ++) {
473 $o .= '<th>' . mb_substr(DI::l10n()->getDay($dn[$a]), 0, 3, 'UTF-8') . '</th>';
479 if (($dow == $f) && (!$started)) {
483 $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
485 $day = str_replace(' ', ' ', sprintf('%2.2d', $d));
487 if (isset($links[$d])) {
488 $o .= "<a href=\"{$links[$d]}\">$day</a>";
500 if (($dow == 7) && ($d <= $l)) {
507 for ($a = $dow; $a < 7; $a ++) {
508 $o .= '<td> </td>';
512 $o .= '</tr></table>' . "\r\n";