Fixed #860 // Cache item throw an error on save with DateTimeImmutable date objects

Author: Geolim4

lib/Phpfastcache/Core/Item/CacheItemTrait.php

@@ -102,7 +102,7 @@ public function expiresAt(?\DateTimeInterface $expiration): static
     {
         if ($expiration instanceof DateTimeInterface) {
             $this->eventManager->dispatch(Event::CACHE_ITEM_EXPIRE_AT, $this, $expiration);
-            $this->expirationDate = $expiration;
+            $this->expirationDate = $this->demutateDatetime($expiration);
         } else {
             throw new PhpfastcacheInvalidArgumentException('$expiration must be an object implementing the DateTimeInterface got: ' . \gettype($expiration));
         }
@@ -139,4 +139,11 @@ public function expiresAfter(int|\DateInterval|null $time): static
 
         return $this;
     }
+
+    protected function demutateDatetime(\DateTimeInterface $dateTime): \DateTimeInterface
+    {
+        return $dateTime instanceof \DateTimeImmutable
+            ? \DateTime::createFromImmutable($dateTime)
+            : $dateTime;
+    }
 }

lib/Phpfastcache/Core/Item/ExtendedCacheItemTrait.php

@@ -136,7 +136,7 @@ public function getCreationDate(): DateTimeInterface
     public function setCreationDate(DateTimeInterface $date): ExtendedCacheItemInterface
     {
         if ($this->driver->getConfig()->isItemDetailedDate()) {
-            $this->creationDate = $date;
+            $this->creationDate = $this->demutateDatetime($date);
             return $this;
         }
 
@@ -163,7 +163,7 @@ public function getModificationDate(): DateTimeInterface
     public function setModificationDate(DateTimeInterface $date): ExtendedCacheItemInterface
     {
         if ($this->driver->getConfig()->isItemDetailedDate()) {
-            $this->modificationDate = $date;
+            $this->modificationDate = $this->demutateDatetime($date);
             return $this;
         }
 

lib/Phpfastcache/Core/Pool/DriverBaseTrait.php

@@ -203,11 +203,11 @@ public function driverUnwrapData(array $wrapper): mixed
 
     /**
      * @param array $wrapper
-     * @return DateTime
+     * @return DateTimeInterface
      */
-    public function driverUnwrapEdate(array $wrapper): \DateTime
+    public function driverUnwrapEdate(array $wrapper): \DateTimeInterface
     {
-        if ($wrapper[self::DRIVER_EDATE_WRAPPER_INDEX] instanceof \DateTime) {
+        if ($wrapper[self::DRIVER_EDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {
             return $wrapper[self::DRIVER_EDATE_WRAPPER_INDEX];
         }
 
@@ -216,11 +216,11 @@ public function driverUnwrapEdate(array $wrapper): \DateTime
 
     /**
      * @param array $wrapper
-     * @return DateTime|null
+     * @return DateTimeInterface|null
      */
-    public function driverUnwrapCdate(array $wrapper): ?\DateTime
+    public function driverUnwrapCdate(array $wrapper): ?\DateTimeInterface
     {
-        if ($wrapper[self::DRIVER_CDATE_WRAPPER_INDEX] instanceof \DateTime) {
+        if ($wrapper[self::DRIVER_CDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {
             return $wrapper[self::DRIVER_CDATE_WRAPPER_INDEX];
         }
 
@@ -229,11 +229,11 @@ public function driverUnwrapCdate(array $wrapper): ?\DateTime
 
     /**
      * @param array $wrapper
-     * @return DateTime|null
+     * @return DateTimeInterface|null
      */
-    public function driverUnwrapMdate(array $wrapper): ?\DateTime
+    public function driverUnwrapMdate(array $wrapper): ?\DateTimeInterface
     {
-        if ($wrapper[self::DRIVER_MDATE_WRAPPER_INDEX] instanceof \DateTime) {
+        if ($wrapper[self::DRIVER_MDATE_WRAPPER_INDEX] instanceof \DateTimeInterface) {
             return $wrapper[self::DRIVER_MDATE_WRAPPER_INDEX];
         }
 

tests/issues/Github-860.test.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <khoaofgod@gmail.com> https://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ */
+
+use Phpfastcache\CacheManager;
+use Phpfastcache\Drivers\Files\Config as FilesConfig;
+use Phpfastcache\Tests\Helper\TestHelper;
+
+chdir(__DIR__);
+require_once __DIR__ . '/../../vendor/autoload.php';
+$testHelper = new TestHelper('Github issue #860 - Cache item throw an error on save with DateTimeImmutable date objects');
+
+$config = new FilesConfig();
+$testHelper->preConfigure($config);
+$cacheInstance = CacheManager::getInstance('Files', $config);
+$cacheInstance->clear();
+
+try {
+    $key = 'pfc_' . bin2hex(random_bytes(12));
+    $item = $cacheInstance->getItem($key);
+    $item->set(random_int(1000, 999999))
+        ->setExpirationDate(new DateTimeImmutable('+1 month'))
+        ->setCreationDate(new DateTimeImmutable())
+        ->setModificationDate(new DateTimeImmutable('+1 week'));
+    $cacheInstance->save($item);
+    $cacheInstance->detachAllItems();
+    $item = $cacheInstance->getItem($key);
+    $testHelper->assertPass('Github issue #860 have not regressed.');
+} catch (\TypeError $e) {
+    $testHelper->assertFail('Github issue #860 have regressed, exception caught: ' . $e->getMessage());
+}
+