Relax LastModifiedDeterminator interface to use DateTimeInterface as return type

Author: mpdude

README.md

@@ -99,7 +99,7 @@ final class PostsLastModifiedDeterminator implements LastModifiedDeterminator
         private readonly BlogPostRepository $blogPostRepository,
     ) {
 
-    public function getLastModified(Request $request): ?\DateTime
+    public function getLastModified(Request $request): ?\DateTimeInterface
     {
         $post = $this->blogPostRepository->findLatest();
 

src/DependencyInjection/WebfactoryHttpCacheExtension.php

@@ -7,6 +7,10 @@
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 
+/**
+ * @internal
+ * @psalm-internal Webfactory\HttpCacheBundle
+ */
 class WebfactoryHttpCacheExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void

src/NotModified/Attribute/ReplaceWithNotModifiedResponse.php

@@ -10,7 +10,7 @@
 namespace Webfactory\HttpCacheBundle\NotModified\Attribute;
 
 use Attribute;
-use DateTime;
+use DateTimeInterface;
 use RuntimeException;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -27,14 +27,18 @@ final class ReplaceWithNotModifiedResponse
     /** @var LastModifiedDeterminator[] */
     private array $lastModifiedDeterminators;
     private ContainerInterface $container;
-    private ?DateTime $lastModified = null;
+    private ?DateTimeInterface $lastModified = null;
 
     public function __construct(
         private readonly array $parameters,
     ) {
     }
 
-    public function determineLastModified(Request $request): ?DateTime
+    /**
+     * @internal
+     * @psalm-internal Webfactory\HttpCacheBundle
+     */
+    public function determineLastModified(Request $request): ?DateTimeInterface
     {
         $this->initialiseLastModifiedDeterminators();
 
@@ -48,6 +52,10 @@ public function determineLastModified(Request $request): ?DateTime
         return $this->lastModified;
     }
 
+    /**
+     * @internal
+     * @psalm-internal Webfactory\HttpCacheBundle
+     */
     public function setContainer(ContainerInterface $container): void
     {
         $this->container = $container;

src/NotModified/EventListener.php

@@ -20,6 +20,9 @@
  * Symfony EventListener for adding a "last modified" header to the response on the one hand. On the other hand, it
  * replaces the execution of a controller action with a Not Modified HTTP response, if no newer "last modified" date is
  * determined than the one in the header of a subsequent request.
+ *
+ * @internal
+ * @psalm-internal Webfactory\HttpCacheBundle
  */
 final class EventListener
 {

src/NotModified/LastModifiedDeterminator.php

@@ -9,7 +9,7 @@
 
 namespace Webfactory\HttpCacheBundle\NotModified;
 
-use DateTime;
+use DateTimeInterface;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
@@ -22,7 +22,7 @@
 interface LastModifiedDeterminator
 {
     /**
-     * @return DateTime|null
+     * @return ?DateTimeInterface
      */
     public function getLastModified(Request $request);
 }

tests/NotModified/Attribute/ReplaceWithNotModifiedResponseTest.php

@@ -10,6 +10,7 @@
 namespace Webfactory\HttpCacheBundle\Tests\NotModified\Attribute;
 
 use DateTime;
+use DateTimeInterface;
 use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\Test;
@@ -103,14 +104,14 @@ final class FakeLastModifiedDeterminatorWithoutInterface
 
 final class MyLastModifedDeterminator implements LastModifiedDeterminator
 {
-    private DateTime $lastModified;
+    private ?DateTimeInterface $lastModified;
 
-    public function __construct(?DateTime $lastModified = null)
+    public function __construct(?DateTimeInterface $lastModified = null)
     {
         $this->lastModified = $lastModified ?: DateTime::createFromFormat('U', time());
     }
 
-    public function getLastModified(Request $request): DateTime
+    public function getLastModified(Request $request): ?DateTimeInterface
     {
         return $this->lastModified;
     }

tests/NotModified/EventListenerTest.php

@@ -11,6 +11,7 @@
 
 use Closure;
 use DateTime;
+use DateTimeInterface;
 use Error;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\Test;
@@ -269,23 +270,23 @@ public static function actionWithMoreThanOneAttribute(): Response
 
 final class AbstainingLastModifiedDeterminator implements LastModifiedDeterminator
 {
-    public function getLastModified(Request $request): ?DateTime
+    public function getLastModified(Request $request): ?DateTimeInterface
     {
         return null;
     }
 }
 
 final class OneDayAgoModifiedLastModifiedDeterminator implements LastModifiedDeterminator
 {
-    public function getLastModified(Request $request): DateTime
+    public function getLastModified(Request $request): ?DateTimeInterface
     {
         return DateTime::createFromFormat('U', time() - 86400);
     }
 }
 
 final class FixedDateAgoModifiedLastModifiedDeterminator implements LastModifiedDeterminator
 {
-    public function getLastModified(Request $request): DateTime
+    public function getLastModified(Request $request): ?DateTimeInterface
     {
         return new DateTime('2000-01-01');
     }