Updated changelog & upgraded API version + some small fixes

Geolim4 · Geolim4 · commit a2f32831fc6c · 2022-04-02T02:41:29.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,10 @@
 ## 9.1.0
-##### xx april 2022
+##### 04 april 2022
+- __API__
+  - Upgraded Phpfastcache API to `4.1.0` ([see changes](CHANGELOG_API.md))
 - __Core__
   - Deprecated `\Phpfastcache\Config\Config::class` 
+  - Removed/reworked/improved dead/unreachable/redundant/obsolete code, thanks to `Phpstan`
 - __Drivers__
   - **Added `Solr` driver support**
 - __Cluster__
@@ -40,7 +43,7 @@
 - __PSR-16__
   - Upgraded `psr/simple-cache` dependency to `^2.0||^3.0` (for PHP-8 types)
 - __API__
-  - Upgraded Phpfastcache API `4.0.0` ([see changes](CHANGELOG_API.md))
+  - Upgraded Phpfastcache API to `4.0.0` ([see changes](CHANGELOG_API.md))
   - Renamed `Api::getPhpFastCacheVersion()` to `Api::getPhpfastcacheVersion()`
   - Renamed `Api::getPhpFastCacheChangelog()` to `Api::getPhpfastcacheChangelog()`
   - Renamed `Api::getPhpFastCacheGitHeadHash()` to `Api::getPhpfastcacheGitHeadHash()`
diff --git a/CHANGELOG_API.md b/CHANGELOG_API.md
@@ -1,3 +1,9 @@
+## 4.1.0
+- Extended `CacheItemPoolInterface::save()` with `ExtendedCacheItemPoolInterface::save()` for re-typing
+- Method `ExtendedCacheItemPoolInterface::getConfig()` now returns `ConfigurationOptionInterface` instead of `ConfigurationOption`
+- Method `ExtendedCacheItemPoolInterface::getDefaultConfig()` now returns `ConfigurationOptionInterface` instead of `ConfigurationOption`
+- Method `EventManagerInterface::getInstance()` now returns `EventManagerInterface` instead of `static`
+
 ## 4.0.0
 - **[BC Break]** Upgraded `psr/cache` dependency to `^3.0` which required `ExtendedCacheItemPoolInterface` and `ExtendedCacheItemInterface` updates
 - **[BC Break]** Increased minimum PHP compatibility to `^8.0` which also required `TaggableCacheItemPoolInterface` and `TaggableCacheItemInterface` updates
diff --git a/README.md b/README.md
diff --git a/lib/Phpfastcache/Api.php b/lib/Phpfastcache/Api.php
@@ -21,11 +21,11 @@
 
 /**
  * Class Api
- * @package phpFastCache
+ * @package Phpfastcache
  */
 class Api
 {
-    protected static string $version = '4.0.0';
+    protected static string $version = '4.1.0';
 
     /**
      * Api constructor.
diff --git a/lib/Phpfastcache/Cluster/AggregatablePoolInterface.php b/lib/Phpfastcache/Cluster/AggregatablePoolInterface.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/AggregatorInterface.php b/lib/Phpfastcache/Cluster/AggregatorInterface.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/ClusterAggregator.php b/lib/Phpfastcache/Cluster/ClusterAggregator.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/ClusterPoolAbstract.php b/lib/Phpfastcache/Cluster/ClusterPoolAbstract.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
@@ -182,7 +182,7 @@ protected function getStandardizedItem(ExtendedCacheItemInterface $item, Extende
              */
             if ($driverPool === $this) {
                 /** @var ExtendedCacheItemInterface $itemPool */
-                $itemClass = $driverPool->getItemClass();
+                $itemClass = $driverPool::getItemClass();
                 $itemPool = new $itemClass($this, $item->getKey(), $this->getEventManager());
                 $item->cloneInto($itemPool, $driverPool);
 
diff --git a/lib/Phpfastcache/Cluster/ClusterPoolInterface.php b/lib/Phpfastcache/Cluster/ClusterPoolInterface.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/ClusterPoolTrait.php b/lib/Phpfastcache/Cluster/ClusterPoolTrait.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/Drivers/FullReplication/Driver.php b/lib/Phpfastcache/Cluster/Drivers/FullReplication/Driver.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/Drivers/MasterSlaveReplication/Driver.php b/lib/Phpfastcache/Cluster/Drivers/MasterSlaveReplication/Driver.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/Drivers/RandomReplication/Driver.php b/lib/Phpfastcache/Cluster/Drivers/RandomReplication/Driver.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Cluster/Drivers/SemiReplication/Driver.php b/lib/Phpfastcache/Cluster/Drivers/SemiReplication/Driver.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Core/Pool/CacheItemPoolTrait.php b/lib/Phpfastcache/Core/Pool/CacheItemPoolTrait.php
@@ -57,7 +57,7 @@ trait CacheItemPoolTrait
      */
     public function setItem(CacheItemInterface $item): static
     {
-        if ($this->getItemClass() === $item::class) {
+        if (self::getItemClass() === $item::class) {
             if (!$this->getConfig()->isUseStaticItemCaching()) {
                 throw new PhpfastcacheLogicException(
                     'The static item caching option (useStaticItemCaching) is disabled so you cannot attach an item.'
@@ -199,7 +199,7 @@ public function getItem(string $key): ExtendedCacheItemInterface
                      * Reset the Item
                      */
                     $item->set(null)
-                        ->expiresAfter(abs((int)$this->getConfig()->getDefaultTtl()))
+                        ->expiresAfter(abs($this->getConfig()->getDefaultTtl()))
                         ->setHit(false)
                         ->setTags([]);
                     if ($this->getConfig()->isItemDetailedDate()) {
@@ -414,6 +414,10 @@ public function save(CacheItemInterface $item): bool
 
         if ($this->driverWrite($item) && $this->driverWriteTags($item)) {
             $item->setHit(true);
+            if ($this->getConfig()->isItemDetailedDate()) {
+                $item->setModificationDate(new \DateTime());
+            }
+
             $this->getIO()->incWriteHit();
 
             return true;
diff --git a/lib/Phpfastcache/Core/Pool/DriverBaseTrait.php b/lib/Phpfastcache/Core/Pool/DriverBaseTrait.php
@@ -162,12 +162,11 @@ public function driverPreWrap(ExtendedCacheItemInterface $item, bool $stringifyD
         }
 
         if ($stringifyDate) {
-            $wrap = \array_map(static function ($value) {
-                if ($value instanceof DateTimeInterface) {
-                    return $value->format(DateTimeInterface::W3C);
+            \array_walk($wrap, static function (mixed &$value, string $key): void {
+                if ($value instanceof DateTimeInterface && $key !== self::DRIVER_DATA_WRAPPER_INDEX) {
+                    $value = $value->format(DateTimeInterface::W3C);
                 }
-                return $value;
-            }, $wrap);
+            });
         }
 
         return $wrap;
diff --git a/lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolInterface.php b/lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolInterface.php
@@ -97,7 +97,7 @@ public function getDriverName(): string;
     public function getInstanceId(): string;
 
     /**
-     * [phpFastCache phpDoc Override]
+     * [Phpfastcache phpDoc Override]
      * Returns a Cache Item representing the specified key.
      *
      * This method must always return a CacheItemInterface object, even in case of
@@ -116,10 +116,10 @@ public function getInstanceId(): string;
     public function getItem(string $key): ExtendedCacheItemInterface;
 
     /**
-     * [phpFastCache phpDoc Override]
+     * [Phpfastcache phpDoc Override]
      * Returns a traversable set of cache items.
      *
-     * @param array $keys
+     * @param string[] $keys
      * An indexed array of keys of items to retrieve.
      *
      * @return ExtendedCacheItemInterface[]
@@ -177,6 +177,17 @@ public function attachItem(CacheItemInterface $item): static;
      */
     public function isAttached(CacheItemInterface $item): bool;
 
+    /**
+     * Persists a cache item immediately.
+     *
+     * @param ExtendedCacheItemInterface|CacheItemInterface $item
+     *   The cache item to save.
+     *
+     * @return bool
+     *   True if the item was successfully persisted. False if there was an error.
+     */
+    public function save(ExtendedCacheItemInterface|CacheItemInterface $item): bool;
+
     /**
      * Save multiple items, possible uses:
      *  saveMultiple([$item1, $item2, $item3]);
diff --git a/lib/Phpfastcache/Drivers/Zenddisk/Driver.php b/lib/Phpfastcache/Drivers/Zenddisk/Driver.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Drivers/Zenddisk/Item.php b/lib/Phpfastcache/Drivers/Zenddisk/Item.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Drivers/Zendshm/Driver.php b/lib/Phpfastcache/Drivers/Zendshm/Driver.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/lib/Phpfastcache/Drivers/Zendshm/Item.php b/lib/Phpfastcache/Drivers/Zendshm/Item.php
@@ -2,7 +2,7 @@
 
 /**
  *
- * This file is part of phpFastCache.
+ * This file is part of Phpfastcache.
  *
  * @license MIT License (MIT)
  *
diff --git a/quality.bat b/quality.bat
@@ -4,6 +4,6 @@ setlocal
 call vendor\bin\phpcbf lib/ --report=summary
 call vendor\bin\phpcs lib/ --report=summary
 call vendor\bin\phpmd lib/ ansi phpmd.xml
-call vendor\bin\phpstan analyse lib/ -l 2 -c phpstan.neon 2>&1
+call vendor\bin\phpstan analyse lib/ -l 4 -c phpstan.neon 2>&1
 
 endlocal

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * This file is part of phpFastCache.`
	`5`	`+ * This file is part of Phpfastcache.`
`6`	`6`	`*`
`7`	`7`	`* @license MIT License (MIT)`
`8`	`8`	`*`