Add new methods to DateTimeHelper (#19)

Author: mackrais

src/DateTimeHelper.php

@@ -176,6 +176,34 @@ public function createDateTimeImmutableFromFormat(string $dateTimeAsString, stri
         return $result;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function createDateTimeImmutableFromTimestamp(int $timestamp): \DateTimeImmutable
+    {
+        $result = \DateTimeImmutable::createFromFormat('U', (string) $timestamp);
+
+        if (!$result instanceof \DateTimeImmutable) {
+            throw new InvalidArgumentException(\sprintf('Could not create a \DateTimeImmutable object from string "%s" from format "%s".', (string) $timestamp, 'U'));
+        }
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createDateTimeFromTimestamp(int $timestamp): \DateTime
+    {
+        $result = \DateTime::createFromFormat('U', (string) $timestamp);
+
+        if (!$result instanceof \DateTime) {
+            throw new InvalidArgumentException(\sprintf('Could not create a \DateTime object from string "%s" from format "%s".', (string) $timestamp, 'U'));
+        }
+
+        return $result;
+    }
+
     /**
      * @param DateRangeInterface $dateRange
      *

tests/DateTimeHelperTest.php

@@ -20,6 +20,7 @@
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use TypeError;
 
 /**
  * DateTimeHelperTest.
@@ -33,6 +34,7 @@ class DateTimeHelperTest extends TestCase
 
     protected function setUp(): void
     {
+        date_default_timezone_set('UTC');
         $this->dateRange = $this->createMock(DateRangeInterface::class);
         $this->dateTimeHelper = new DateTimeHelper();
     }
@@ -283,4 +285,52 @@ public function createDateTimeImmutableFromFormatWithException(): void
 
         $this->dateTimeHelper->createDateTimeImmutableFromFormat(dateTimeAsString: 'fake');
     }
+
+    #[Test]
+    public function createDateTimeImmutableFromTimestamp(): void
+    {
+        $timestamp = 1710183600;
+        $dateTimeImmutable = $this->dateTimeHelper->createDateTimeImmutableFromTimestamp($timestamp);
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $dateTimeImmutable);
+
+        $this->assertSame(0, $dateTimeImmutable->getOffset());
+
+        $expectedTimezone = date_default_timezone_get();
+        $this->assertContains($dateTimeImmutable->getTimezone()->getName(), [$expectedTimezone, '+00:00']);
+
+        $expectedDateTime = new \DateTimeImmutable('@' . $timestamp, new \DateTimeZone($expectedTimezone));
+        $this->assertSame($expectedDateTime->format('Y-m-d H:i:s'), $dateTimeImmutable->format('Y-m-d H:i:s'));
+    }
+
+    #[Test]
+    public function createDateTimeImmutableFromInvalidTimestamp(): void
+    {
+        $this->expectException(TypeError::class);
+        $this->dateTimeHelper->createDateTimeImmutableFromTimestamp(999999999999999999999999999);
+    }
+
+    #[Test]
+    public function createDateTimeFromTimestamp(): void
+    {
+        $timestamp = 1710183600; // 2024-03-11 12:00:00 UTC
+        $dateTime = $this->dateTimeHelper->createDateTimeFromTimestamp($timestamp);
+
+        $this->assertInstanceOf(\DateTime::class, $dateTime);
+
+        $this->assertSame(0, $dateTime->getOffset());
+
+        $expectedTimezone = date_default_timezone_get();
+        $this->assertContains($dateTime->getTimezone()->getName(), [$expectedTimezone, '+00:00']);
+
+        $expectedDateTime = new \DateTimeImmutable('@' . $timestamp, new \DateTimeZone($expectedTimezone));
+        $this->assertSame($expectedDateTime->format('Y-m-d H:i:s'), $dateTime->format('Y-m-d H:i:s'));
+    }
+
+    #[Test]
+    public function createDateTimeFromInvalidTimestamp(): void
+    {
+        $this->expectException(TypeError::class);
+        $this->dateTimeHelper->createDateTimeFromTimestamp(999999999999999999999999999);
+    }
 }