feat: add HumanDates

HumanDates.php

@@ -0,0 +1,126 @@
+<?php
+
+namespace RockFrontend;
+
+class HumanDates
+{
+  /* default range patterns */
+  const rangePatterns = [
+    // 1. Jan. 2023 - 3. Feb. 2024
+    'default'   => ['d. MMM y', ' – ', 'd. MMM y'],
+
+    // 1. Jan. - 3. Feb. 2023
+    'sameYear'  => ['d. MMM', ' – ', 'd. MMM y'],
+
+    // 1. - 3. Jan. 2023
+    'sameMonth' => ['d.', ' – ', 'd. MMM y'],
+
+    // 1. Jan. 2023
+    'sameDay'   => ['d. MMM y', '', ''],
+  ];
+
+  /** @var IntlDateFormatter */
+  private $formatter;
+
+  private $patterns = self::rangePatterns;
+
+  function __construct(
+    $locale = "en_GB",
+    $format = "d. MMM y",
+    $patterns = null,
+  ) {
+    $this->setPatterns($patterns);
+    $this->setLocale($locale);
+    $this->setFormat($format);
+  }
+
+  /**
+   * Format a single date as human readable date string
+   */
+  function format($time, $format = null): string
+  {
+    if ($format) {
+      $formatter = clone $this->formatter;
+      $formatter->setPattern($format);
+    } else $formatter = $this->formatter;
+    return $formatter->format($this->timestamp($time));
+  }
+
+  /**
+   * Given a timestamp return a formatted date string
+   */
+  private function getString(int $timestamp, $pattern): string
+  {
+    if (!$pattern) return '';
+    if (!$timestamp) return '';
+    $this->formatter->setPattern($pattern);
+    return $this->formatter->format($timestamp);
+  }
+
+  /**
+   * Format a daterange as human readable date string
+   */
+  function range($from, $to): string
+  {
+    $from = $this->timestamp($from);
+    $to = $this->timestamp($to);
+
+    if (date("Ymd", $from) === date("Ymd", $to)) $pattern = 'sameDay';
+    elseif (date("Ym", $from) === date("Ym", $to)) $pattern = 'sameMonth';
+    elseif (date("Y", $from) === date("Y", $to)) $pattern = 'sameYear';
+    else $pattern = 'default';
+
+    $pattern = $this->patterns[$pattern];
+    $pieces = array_filter([
+      $this->getString($from, $pattern[0]),
+      $this->getString($to, $pattern[2]),
+    ]);
+    return implode($pattern[1], $pieces);
+  }
+
+  /**
+   * Set default date format pattern
+   */
+  function setFormat(string $format): self
+  {
+    $this->formatter->setPattern($format);
+    return $this;
+  }
+
+  /**
+   * Set locale of the IntlDateFormatter used to format dates
+   */
+  function setLocale($locale): self
+  {
+    $this->formatter = new IntlDateFormatter(
+      $locale,
+      IntlDateFormatter::NONE,
+      IntlDateFormatter::NONE,
+    );
+    return $this;
+  }
+
+  /**
+   * Set range patterns
+   */
+  function setPatterns($patterns): self
+  {
+    if (!$patterns) return $this;
+    $this->patterns = array_merge(self::rangePatterns, $patterns);
+    return $this;
+  }
+
+  /**
+   * Convert time to timestamp
+   * Use syntax supported by strtotime()
+   */
+  private function timestamp($time): int
+  {
+    if (is_string($time)) {
+      if (is_numeric($time)) $time = (int)$time;
+      else $time = strtotime($time);
+    }
+    if (is_int($time)) return $time;
+    return 0;
+  }
+}

RockFrontend.module.php

@@ -5,6 +5,7 @@
 use Latte\Engine;
 use Latte\Runtime\Html;
 use RockFrontend\Asset;
+use RockFrontend\HumanDates;
 use RockFrontend\LiveReload;
 use RockFrontend\Manifest;
 use RockFrontend\ScriptsArray;
@@ -1018,6 +1019,12 @@ public static function html($str)
     }
   }
 
+  function HumanDates($locale = "de_AT"): HumanDates
+  {
+    require_once __DIR__ . "/HumanDates.php";
+    return new HumanDates($locale);
+  }
+
   /**
    * Render icon link
    * @return string

docs/humandates/readme.md

@@ -0,0 +1,6 @@
+# HumanDates
+
+```php
+// 1. - 3. Jän. 2023
+echo $rockfrontend->humandates("de_AT")->range("2023-1-1", "2023-1-3");
+```