Added aeon_datetime_create filder (#68)

Author: norberttech

composer.json

@@ -6,8 +6,8 @@
     "prefer-stable": true,
     "minimum-stability": "dev",
     "require": {
-        "php": ">=7.4.2",
-        "aeon-php/calendar": ">=0.18.0",
+        "php": "^7.4.2 || ^8.0",
+        "aeon-php/calendar": "^1.0",
         "twig/twig": "^1.43|^2.10|^3"
     },
     "license": "MIT",

composer.lock

@@ -46,6 +46,7 @@ public function __construct(Calendar $calendar, string $defaultTimeZone = 'UTC',
     public function getFilters() : array
     {
         return [
+            new TwigFilter('aeon_datetime_create', [$this, 'aeon_datetime_create']),
             new TwigFilter('aeon_datetime_format', [$this, 'aeon_datetime_format']),
             new TwigFilter('aeon_day_format', [$this, 'aeon_day_format']),
             new TwigFilter('aeon_time_format', [$this, 'aeon_time_format']),
@@ -78,6 +79,39 @@ public function getFunctions() : array
         ];
     }
 
+    /**
+     * @param \DateTimeInterface|int|string $dateTime
+     * @param null|string $timezone
+     *
+     * @throws InvalidArgumentException
+     *
+     * @return DateTime
+     *
+     * @psalm-suppress RedundantConditionGivenDocblockType
+     */
+    public function aeon_datetime_create($dateTime, string $timezone = null) : DateTime
+    {
+        if (\is_string($dateTime)) {
+            $aeonDateTime = DateTime::fromString($dateTime);
+        } elseif ($dateTime instanceof \DateTimeInterface) {
+            $aeonDateTime = DateTime::fromDateTime($dateTime);
+        } elseif (\is_int($dateTime)) {
+            $aeonDateTime = DateTime::fromTimestampUnix($dateTime);
+        } else {
+            throw new InvalidArgumentException("Expected string, \DateTimeInterface or integer, got " . \gettype($dateTime));
+        }
+
+        $tz = (\is_string($timezone) && TimeZone::isValid($timezone))
+            ? TimeZone::fromString($timezone)
+            : null;
+
+        if ($tz instanceof TimeZone) {
+            return $aeonDateTime->toTimeZone($tz);
+        }
+
+        return $aeonDateTime;
+    }
+
     public function aeon_datetime_format(DateTime $dateTime, string $format = null, string $timezone = null) : string
     {
         $tz = (\is_string($timezone) && TimeZone::isValid($timezone))

src/Aeon/Twig/CalendarExtension.php

@@ -28,6 +28,25 @@ public function test_extension() : void
         $this->assertInstanceOf(ExtensionInterface::class, new CalendarExtension($this->calendarStub));
     }
 
+    public function test_filter_aeon_datetime_create() : void
+    {
+        $twig = new Environment(
+            new FilesystemLoader(
+                [
+                    __DIR__ . '/Fixtures/filters',
+                ]
+            )
+        );
+        $twig->addExtension(new CalendarExtension($this->calendarStub, 'UTC', 'Y-m-d H:i:sO', 'Y-m-d', 'H:i:s'));
+
+        $this->assertStringEqualsFile(
+            __DIR__ . '/Fixtures/filters/aeon_datetime_create.txt',
+            $twig->render('aeon_datetime_create.twig.txt', [
+                'phpDateTime' => new \DateTimeImmutable('2020-01-01 00:00:00'),
+            ])
+        );
+    }
+
     public function test_filter_aeon_datetime() : void
     {
         $twig = new Environment(

tests/Aeon/Twig/Tests/Integration/CalendarExtensionTest.php

@@ -0,0 +1,4 @@
+{{ '2020-01-01 00:00:00' | aeon_datetime_create | aeon_datetime_format }}
+{{ 1577836800 | aeon_datetime_create | aeon_datetime_format }}
+{{ phpDateTime | aeon_datetime_create | aeon_datetime_format }}
+{{ '2020-01-01 00:00:00' | aeon_datetime_create('America/Los_Angeles') | aeon_datetime_format(null, 'America/Los_Angeles') }}

tests/Aeon/Twig/Tests/Integration/Fixtures/filters/aeon_datetime_create.twig.txt

@@ -0,0 +1,4 @@
+2020-01-01 00:00:00+0000
+2020-01-01 00:00:00+0000
+2020-01-01 00:00:00+0000
+2019-12-31 16:00:00-0800

tests/Aeon/Twig/Tests/Integration/Fixtures/filters/aeon_datetime_create.txt

@@ -24,6 +24,33 @@ public function test_create_with_invalid_timezone() : void
         new CalendarExtension($calendar = new GregorianCalendarStub(TimeZone::UTC()), 'not_timezone');
     }
 
+    public function test_aeon_create_from_string() : void
+    {
+        $extension = new CalendarExtension($calendar = new GregorianCalendarStub(TimeZone::UTC()));
+
+        $this->assertEquals(DateTime::fromString('2002-01-01 00:00:00 UTC'), $extension->aeon_datetime_create('2002-01-01 00:00:00 UTC'));
+    }
+
+    public function test_aeon_create_from_string_with_tz() : void
+    {
+        $extension = new CalendarExtension($calendar = new GregorianCalendarStub(TimeZone::UTC()));
+
+        $this->assertEquals(
+            DateTime::fromString('2001-12-31 16:00:00 America/Los_Angeles'),
+            $extension->aeon_datetime_create('2002-01-01 00:00:00 UTC', 'America/Los_Angeles')
+        );
+    }
+
+    public function test_aeon_create_from_invalid_type() : void
+    {
+        $extension = new CalendarExtension($calendar = new GregorianCalendarStub(TimeZone::UTC()));
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Expected string, \DateTimeInterface or integer, got array');
+
+        $extension->aeon_datetime_create(['array'], 'America/Los_Angeles');
+    }
+
     public function test_aeon_now() : void
     {
         $extension = new CalendarExtension($calendar = new GregorianCalendarStub(TimeZone::UTC()));