Started 9.2 (WIP):

- __API__
  - Upgraded Phpfastcache API to `4.3.0` ([see changes](CHANGELOG_API.md))
- __Drivers__
  - Implemented #906 // **Added `RedisCluster` driver support**
- __Pool__
  - Added `ExtendedCacheItemPoolTrait::getAllItems` to allow you to retrieve all items in the cache. This method have some limitations, ([see more in the Wiki](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV5%CB%96%5D-Fetching-all-keys)).
- __Core__
  - Configuration methods`ConfigurationOption::isPreventCacheSlams()`, `ConfigurationOption::setPreventCacheSlams()`, `ConfigurationOption::getCacheSlamsTimeout()`, `ConfigurationOption::setCacheSlamsTimeout()` are deprecated. ([See changes](CHANGELOG_API.md)).
  - Fixed #907 // Internal "driver decode()" method will now throw an if the string data looks corrupted.
  - Internal: Implemented multiple keys fetch (*if supported by the backend*) to improve the performances behind all `getItems()` calls. Currently only supported in some backends, but it may evolve in the future.
- __Misc__
  - Fixed multiple code typo & updated README.md

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 9.2.0
+##### xx january 2024
+- __API__
+  - Upgraded Phpfastcache API to `4.3.0` ([see changes](CHANGELOG_API.md))
+- __Drivers__
+  - Implemented #906 // **Added `RedisCluster` driver support**
+- __Pool__
+  - Added `ExtendedCacheItemPoolTrait::getAllItems` to allow you to retrieve all items in the cache. This method have some limitations, ([see more in the Wiki](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV5%CB%96%5D-Fetching-all-keys)).
+- __Core__
+  - Configuration methods`ConfigurationOption::isPreventCacheSlams()`, `ConfigurationOption::setPreventCacheSlams()`, `ConfigurationOption::getCacheSlamsTimeout()`, `ConfigurationOption::setCacheSlamsTimeout()` are deprecated. ([See changes](CHANGELOG_API.md)).
+  - Fixed #907 // Internal "driver decode()" method will now throw an if the string data looks corrupted.
+  - Internal: Implemented multiple keys fetch (*if supported by the backend*) to improve the performances behind all `getItems()` calls. Currently only supported in some backends, but it may evolve in the future.
+- __Misc__
+  - Fixed multiple code typo & updated README.md
+
 ## 9.1.3
 ##### 12 february 2023
 - __Core__

CHANGELOG_API.md

@@ -1,3 +1,15 @@
+## 4.3.0
+- Created method `ExtendedCacheItemPoolTrait::getAllItems(string $pattern = ''): iterable` which will return all the items stored in the cache. This method have some limitations, ([see more in the Wiki](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV5%CB%96%5D-Fetching-all-keys)).
+- Deprecated `ConfigurationOption::isPreventCacheSlams()` for future removal, use `IOConfigurationOption::isPreventCacheSlams()` instead.
+- Deprecated `ConfigurationOption::setPreventCacheSlams()` for future removal, use `IOConfigurationOption::setPreventCacheSlams()` instead.
+- Deprecated `ConfigurationOption::getCacheSlamsTimeout()` for future removal, use `IOConfigurationOption::getCacheSlamsTimeout()` instead.
+- Deprecated `ConfigurationOption::setCacheSlamsTimeout()` for future removal, use `IOConfigurationOption::setCacheSlamsTimeout()` instead.
+- Created `IOConfigurationOption::isPreventCacheSlams()`. This method will **only be available** for `Files, Sqlite, Leveldb` drivers.
+- Created `IOConfigurationOption::setPreventCacheSlams()`. This method will **only be available** for `Files, Sqlite, Leveldb` drivers.
+- Created `IOConfigurationOption::getCacheSlamsTimeout()`. This method will **only be available** for `Files, Sqlite, Leveldb` drivers.
+- Created `IOConfigurationOption::setCacheSlamsTimeout()`. This method will **only be available** for `Files, Sqlite, Leveldb` drivers.
+
+
 ## 4.2.0
 - Created method `\Phpfastcache\Cluster\AggregatablePoolInterface::isAggregatedBy(): ?ClusterPoolInterface` which will return the aggregator object for Cluster aggregators
 - Created method `\Phpfastcache\Cluster\AggregatablePoolInterface::setAggregatedBy(ClusterPoolInterface $clusterPool): static` which will allow to set the aggregator object

composer.json

@@ -23,7 +23,16 @@
         "psr/cache": "^2.0||^3.0",
         "psr/simple-cache": "^2.0||^3.0",
         "ext-mbstring": "*",
-        "ext-json": "*"
+        "ext-json": "*",
+        "symfony/var-dumper": "^6.0",
+        "doctrine/couchdb": "dev-master",
+        "phpfastcache/phpssdb": "~1.1",
+        "predis/predis": "~1.1",
+        "mongodb/mongodb": "~1.9",
+        "triagens/arangodb": "~3.8",
+        "aws/aws-sdk-php": "~3.2",
+        "google/cloud-firestore": "~1.20",
+        "solarium/solarium": "~6.1"
     },
     "require-dev": {
         "league/climate": "^3.8",

docs/DRIVERS.md

@@ -41,8 +41,9 @@
   * A very high-performance NoSQL driver using a key-value pair system.
 * Predis
   * A high-performance memory driver using a in-memory data structure storage. Less efficient than Redis driver as it is an embedded library.
-* Redis
+* Redis/RedisCluster
   * A very high-performance memory driver using a in-memory data structure storage. More efficient than Predis driver as it is an compiled library.
+  * RedisCluster use the RedisCluster class with a different driver name but behave slightly differently than Redis driver.
 * Riak **(REMOVED in v8.0.6)**
   * A very high-performance NoSQL driver using a key-value pair system.
 * Solr **(Added in V9.1)**

docs/EVENTS.md

@@ -75,7 +75,19 @@ This is an exhaustive list, and it will be updated as soon as new events will be
         - *ExtendedCacheItemPoolInterface::getItems()*
         - *ExtendedCacheItemPoolInterface::getItemsByTag()*
         - *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
-
+- onCacheGetItems(*Callable* **$callback**)
+    - **Callback arguments**
+        - *ExtendedCacheItemPoolInterface* **$itemPool**
+        - *ExtendedCacheItemInterface[]* **$items**
+    - **Scope**
+        - ItemPool
+    - **Description**
+        - Allow you to manipulate a set of items just before it gets returned by the getItems() method.
+    - **Risky Circular Methods**
+        - *ExtendedCacheItemPoolInterface::getItem()*
+        - *ExtendedCacheItemPoolInterface::getItems()*
+        - *ExtendedCacheItemPoolInterface::getItemsByTag()*
+        - *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
 - onCacheDeleteItem(*Callable* **$callback**)
     - **Callback arguments**
         - *ExtendedCacheItemPoolInterface* **$itemPool**

lib/Phpfastcache/Api.php

@@ -28,7 +28,7 @@ class Api
 {
     use UninstanciableObjectTrait;
 
-    protected static string $version = '4.2.0';
+    protected static string $version = '4.3.0';
 
     /**
      * This method will return the current

lib/Phpfastcache/Config/ConfigurationOption.php

@@ -232,6 +232,7 @@ public function setPath(string $path): static
     }
 
     /**
+     * @deprecated This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for `IO` drivers.
      * @return bool
      */
     public function isPreventCacheSlams(): bool
@@ -240,18 +241,27 @@ public function isPreventCacheSlams(): bool
     }
 
     /**
+     * @deprecated This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for `IO` drivers.
      * @param bool $preventCacheSlams
      * @return ConfigurationOption
      * @throws PhpfastcacheLogicException
      */
     public function setPreventCacheSlams(bool $preventCacheSlams): static
     {
+        if ($preventCacheSlams !== $this->preventCacheSlams) {
+            trigger_error(
+                'This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for `IO` drivers.',
+                E_USER_DEPRECATED
+            );
+        }
+
         $this->enforceLockedProperty(__FUNCTION__);
         $this->preventCacheSlams = $preventCacheSlams;
         return $this;
     }
 
     /**
+     * @deprecated This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for `IO` drivers.
      * @return int
      */
     public function getCacheSlamsTimeout(): int
@@ -260,12 +270,19 @@ public function getCacheSlamsTimeout(): int
     }
 
     /**
+     * @deprecated This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for `IO` drivers.
      * @param int $cacheSlamsTimeout
      * @return ConfigurationOption
      * @throws PhpfastcacheLogicException
      */
     public function setCacheSlamsTimeout(int $cacheSlamsTimeout): static
     {
+        if ($cacheSlamsTimeout !== $this->cacheSlamsTimeout) {
+            trigger_error(
+                'This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for `IO` drivers.',
+                E_USER_DEPRECATED
+            );
+        }
         $this->enforceLockedProperty(__FUNCTION__);
         $this->cacheSlamsTimeout = $cacheSlamsTimeout;
         return $this;

lib/Phpfastcache/Config/ConfigurationOptionInterface.php

@@ -106,27 +106,6 @@ public function getPath(): string;
      */
     public function setPath(string $path): static;
 
-    /**
-     * @return bool
-     */
-    public function isPreventCacheSlams(): bool;
-
-    /**
-     * @param bool $preventCacheSlams
-     * @return ConfigurationOption
-     */
-    public function setPreventCacheSlams(bool $preventCacheSlams): static;
-
-    /**
-     * @return int
-     */
-    public function getCacheSlamsTimeout(): int;
-
-    /**
-     * @param int $cacheSlamsTimeout
-     * @return ConfigurationOption
-     */
-    public function setCacheSlamsTimeout(int $cacheSlamsTimeout): static;
     /**
      * @return bool
      */

lib/Phpfastcache/Config/IOConfigurationOption.php

@@ -19,6 +19,9 @@
 use Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException;
 use Phpfastcache\Exceptions\PhpfastcacheLogicException;
 
+/**
+ * @todo: As of V10, imports cache slams properties.
+ */
 class IOConfigurationOption extends ConfigurationOption
 {
     protected bool $secureFileManipulation = false;
@@ -60,7 +63,7 @@ public function isSecureFileManipulation(): bool
 
     /**
      * @param bool $secureFileManipulation
-     * @return self
+     * @return static
      * @throws PhpfastcacheLogicException
      */
     public function setSecureFileManipulation(bool $secureFileManipulation): static
@@ -113,7 +116,7 @@ public function getDefaultChmod(): int
 
     /**
      * @param int $defaultChmod
-     * @return self
+     * @return static
      * @throws PhpfastcacheLogicException
      */
     public function setDefaultChmod(int $defaultChmod): static
@@ -122,4 +125,45 @@ public function setDefaultChmod(int $defaultChmod): static
         $this->defaultChmod = $defaultChmod;
         return $this;
     }
+
+
+    /**
+     * @return bool
+     */
+    public function isPreventCacheSlams(): bool
+    {
+        return $this->preventCacheSlams;
+    }
+
+    /**
+     * @param bool $preventCacheSlams
+     * @return static
+     * @throws PhpfastcacheLogicException
+     */
+    public function setPreventCacheSlams(bool $preventCacheSlams): static
+    {
+        $this->enforceLockedProperty(__FUNCTION__);
+        $this->preventCacheSlams = $preventCacheSlams;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getCacheSlamsTimeout(): int
+    {
+        return $this->cacheSlamsTimeout;
+    }
+
+    /**
+     * @param int $cacheSlamsTimeout
+     * @return static
+     * @throws PhpfastcacheLogicException
+     */
+    public function setCacheSlamsTimeout(int $cacheSlamsTimeout): static
+    {
+        $this->enforceLockedProperty(__FUNCTION__);
+        $this->cacheSlamsTimeout = $cacheSlamsTimeout;
+        return $this;
+    }
 }

lib/Phpfastcache/Config/IOConfigurationOptionInterface.php

@@ -39,4 +39,12 @@ public function setCacheFileExtension(string $cacheFileExtension): static;
     public function getDefaultChmod(): int;
 
     public function setDefaultChmod(int $defaultChmod): static;
+
+    public function isPreventCacheSlams(): bool;
+
+    public function setPreventCacheSlams(bool $preventCacheSlams): static;
+
+    public function getCacheSlamsTimeout(): int;
+
+    public function setCacheSlamsTimeout(int $cacheSlamsTimeout): static;
 }

lib/Phpfastcache/Core/Item/ExtendedCacheItemInterface.php

@@ -44,7 +44,7 @@ interface ExtendedCacheItemInterface extends
     public function getEncodedKey(): string;
 
     /**
-     * Returns the raw value, regardless of hit status.
+     * Returns the cache item value, regardless of hit status.
      * This method can be called if the cache item is NOT YET
      * persisted, and you need to access to its set value.
      *
@@ -53,9 +53,10 @@ public function getEncodedKey(): string;
      *
      * @return mixed
      *
-     * @internal
+     * @internal This method is used internally by phpfastcache, so you should not use it in your application.
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    public function getRawValue(): mixed;
+    public function _getData(): mixed; // @phpcs:ignore
 
     /**
      * @return DateTimeInterface

lib/Phpfastcache/Core/Item/ExtendedCacheItemTrait.php

@@ -93,8 +93,9 @@ public function getEncodedKey(): string
 
     /**
      * @inheritDoc
+     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    public function getRawValue(): mixed
+    public function _getData(): mixed // @phpcs:ignore
     {
         return $this->data;
     }
@@ -281,7 +282,7 @@ public function prepend(array|string $data): ExtendedCacheItemInterface
 
     /**
      * Return the data as a well-formatted string.
-     * Any scalar value will be casted to an array
+     * Any scalar value will be cast to an array
      * @param int $options \json_encode() options
      * @param int $depth \json_encode() depth
      * @return string

lib/Phpfastcache/Core/Item/TaggableCacheItemTrait.php

@@ -160,7 +160,7 @@ public function getRemovedTags(): array
     public function cloneInto(ExtendedCacheItemInterface $itemTarget, ?ExtendedCacheItemPoolInterface $itemPoolTarget = null): void
     {
         $itemTarget->setEventManager($this->getEventManager())
-            ->set($this->getRawValue())
+            ->set($this->_getData())
             ->setHit($this->isHit())
             ->setTags($this->getTags())
             ->expiresAt(clone $this->getExpirationDate())