Add DateUtils::getFormattedShortMonth + tests Return short month locale format

CHANGELOG_add_formatted_short_month.md

@@ -0,0 +1,2 @@
+### Added
+- `DateUtils::getFormattedShortMonth` + tests Return short month locale format

src/Utils/DateUtils.php

@@ -455,6 +455,31 @@ public static function getFormattedLongMonth(\DateTime $date, string $locale = '
         return ucfirst((string) $dateFormatter->format($date));
     }
 
+    /**
+     * Return short month locale format, substring 3 char except "Juin"
+     *
+     * <pre>
+     * <?php
+     * getFormattedShortMonth(new \DateTime('2022-01-15'));
+     * ?>
+     * </pre>
+     * The above example will output:
+     * <pre>
+     * Jan
+     * </pre>
+     */
+    public static function getFormattedShortMonth(\DateTime $date, string $locale = 'fr_FR'): string
+    {
+        $month = self::getFormattedLongMonth($date, $locale);
+
+        // It must be "Juin" in full otherwise there be multiple "Jui." key with "Juillet"
+        if ($month === 'Juin') {
+            return $month;
+        }
+
+        return mb_substr((string)$month, 0, 3);
+    }
+
     /**
      * Return full month year locale format
      *

tests/Utils/DateUtilsTest.php

@@ -1220,6 +1220,23 @@ public function getGetFormattedLongMonthProvider(): array
         ];
     }
 
+    /**
+     * @dataProvider getGetFormattedShortMonthProvider
+     */
+    public function testGetFormattedShortMonth(string $expected, string $date, string $locale): void
+    {
+        $this->assertEquals($expected, DateUtils::getFormattedShortMonth(new \DateTime($date), $locale));
+    }
+
+    public function getGetFormattedShortMonthProvider(): array
+    {
+        return [
+            'Jan (fr)' => ['Jan', '2022-01-15', 'fr_FR'],
+            'Juin' => ['Juin', '2020-06-01', 'fr_FR'],
+            'Jan (en)' => ['Jan', '2020-01-01', 'en_EN'],
+        ];
+    }
+
     /**
      * @dataProvider getGetFormattedLongMonthYearsProvider
      */