fix: Add parsePeriodIdentifier and monthPeriod twig functions

Author: Stephan Wentz

src/Twig/Extension/PeriodExtension.php

@@ -26,6 +26,8 @@ public function __construct(private readonly PeriodFactory $periodFactory)
     public function getFunctions(): array
     {
         return [
+            new TwigFunction('parse_period_identifier', [$this, 'parsePeriodIdentifier'], ['is_safe' => ['html']]),
+            new TwigFunction('month_period', [$this, 'monthPeriod'], ['is_safe' => ['html']]),
             new TwigFunction('current_day_period', [$this, 'currentDayPeriod'], ['is_safe' => ['html']]),
             new TwigFunction('current_week_period', [$this, 'currentWeekPeriod'], ['is_safe' => ['html']]),
             new TwigFunction('current_month_period', [$this, 'currentMonthPeriod'], ['is_safe' => ['html']]),
@@ -52,6 +54,16 @@ public function getFunctions(): array
         ];
     }
 
+    public function parsePeriodIdentifier(string $periodIdentifier): Period
+    {
+        return $this->periodFactory->fromIdentifier($periodIdentifier);
+    }
+
+    public function monthPeriod($periodString): MonthPeriod|null
+    {
+        return $periodString ? MonthPeriod::createFromPeriodString($periodString) : null;
+    }
+
     public function currentDayPeriod(): DayPeriod
     {
         return $this->periodFactory->currentDay();

tests/Twig/Extension/PeriodExtensionTest.php

@@ -39,6 +39,22 @@ public function testGetFunctions(): void
         $this->assertContainsOnlyInstancesOf(TwigFunction::class, $this->extension->getFunctions());
     }
 
+    public function testParsePeriodIdentifier(): void
+    {
+        $this->assertEquals($this->periodFactory->currentDay(), $this->extension->parsePeriodIdentifier('day#2018-06-15'));
+        $this->assertEquals($this->periodFactory->currentWeek(), $this->extension->parsePeriodIdentifier('week#2018-24'));
+        $this->assertEquals($this->periodFactory->currentMonth(), $this->extension->parsePeriodIdentifier('month#2018-06'));
+        $this->assertEquals($this->periodFactory->currentYear(), $this->extension->parsePeriodIdentifier('year#2018'));
+        $this->assertEquals($this->periodFactory->currentRunningWeek(), $this->extension->parsePeriodIdentifier('running-week#2018-24'));
+        $this->assertEquals($this->periodFactory->currentRunningMonth(), $this->extension->parsePeriodIdentifier('running-month#2018-06'));
+        $this->assertEquals($this->periodFactory->currentRunningYear(), $this->extension->parsePeriodIdentifier('running-year#2018'));
+    }
+
+    public function testMonthPeriod(): void
+    {
+        $this->assertEquals($this->periodFactory->currentMonth(), $this->extension->monthPeriod('2018-06'));
+    }
+
     public function testCurrent(): void
     {
         $this->assertEquals($this->periodFactory->currentDay(), $this->extension->currentDayPeriod());