Reworked CacheManager::getInstance, fixed code quality

Author: Geolim4

lib/Phpfastcache/CacheManager.php

@@ -27,6 +27,9 @@
 use Phpfastcache\Exceptions\PhpfastcacheUnsupportedOperationException;
 use Phpfastcache\Util\ClassNamespaceResolverTrait;
 
+/**
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ */
 class CacheManager
 {
     public const CORE_DRIVER_NAMESPACE = 'Phpfastcache\Drivers\\';
@@ -96,16 +99,18 @@ public static function getInstances(): array
      */
     public static function getInstance(string $driver, ?ConfigurationOptionInterface $config = null, ?string $instanceId = null): ExtendedCacheItemPoolInterface
     {
+        if (\class_exists($driver) && \str_starts_with($driver, 'Phpfastcache')) {
+            $driverClass = $driver;
+        } else {
+            $driver = self::normalizeDriverName($driver);
+            $driverClass = self::validateDriverClass(self::getDriverClass($driver));
+        }
         $config = self::validateConfig($config);
-        $driver = self::standardizeDriverName($driver);
-        $instanceId = $instanceId ?: md5($driver . \serialize(\array_filter($config->toArray(), static fn ($val) => !\is_callable($val))));
+        $instanceId = $instanceId ?: self::getInstanceHash($driverClass, $config);
 
         if (!isset(self::$instances[$instanceId])) {
-            $driverClass = self::validateDriverClass(self::getDriverClass($driver));
-
-            if (\class_exists($driverClass)) {
-                $configClass = $driverClass::getConfigClass();
-                if ($configClass !== $config::class) {
+            if (\is_a($driverClass, ExtendedCacheItemPoolInterface::class, true)) {
+                if (($configClass = $driverClass::getConfigClass()) !== $config::class) {
                     $config = new $configClass($config->toArray());
                 }
                 self::$instances[$instanceId] = new $driverClass(
@@ -114,13 +119,32 @@ public static function getInstance(string $driver, ?ConfigurationOptionInterface
                     EventManager::getInstance()
                 );
             } else {
-                throw new PhpfastcacheDriverNotFoundException(sprintf('The driver "%s" does not exists', $driver));
+                throw new PhpfastcacheDriverNotFoundException(sprintf(
+                    'The driver "%s" does not exists or does not implements %s',
+                    $driver,
+                    ExtendedCacheItemPoolInterface::class
+                ));
             }
         }
 
         return self::$instances[$instanceId];
     }
 
+    /**
+     * @param string $driverClass
+     * @param ConfigurationOptionInterface $config
+     * @return string
+     */
+    protected static function getInstanceHash(string $driverClass, ConfigurationOptionInterface $config): string
+    {
+        return \md5($driverClass . \serialize(
+            \array_filter(
+                $config->toArray(),
+                static fn ($val) => $config->isValueSerializable($val)
+            )
+        ));
+    }
+
     /**
      * @param ConfigurationOptionInterface|null $config
      * @return ConfigurationOptionInterface
@@ -146,7 +170,7 @@ public static function getDefaultConfig(): ConfigurationOptionInterface
      * @param string $driverName
      * @return string
      */
-    public static function standardizeDriverName(string $driverName): string
+    public static function normalizeDriverName(string $driverName): string
     {
         return \ucfirst(\strtolower(\trim($driverName)));
     }
@@ -261,7 +285,7 @@ public static function setDefaultConfig(ConfigurationOptionInterface $config): v
      */
     public static function addCustomDriver(string $driverName, string $className): void
     {
-        $driverName = self::standardizeDriverName($driverName);
+        $driverName = self::normalizeDriverName($driverName);
 
         if (empty($driverName)) {
             throw new PhpfastcacheInvalidArgumentException("Can't add a custom driver because its name is empty");
@@ -335,7 +359,7 @@ public static function getDriverList(bool $fqcnAsKey = false): array
      */
     public static function removeCustomDriver(string $driverName): void
     {
-        $driverName = self::standardizeDriverName($driverName);
+        $driverName = self::normalizeDriverName($driverName);
 
         if (empty($driverName)) {
             throw new PhpfastcacheInvalidArgumentException("Can't remove a custom driver because its name is empty");
@@ -358,7 +382,7 @@ public static function removeCustomDriver(string $driverName): void
      */
     public static function addCoreDriverOverride(string $driverName, string $className): void
     {
-        $driverName = self::standardizeDriverName($driverName);
+        $driverName = self::normalizeDriverName($driverName);
 
         if (empty($driverName)) {
             throw new PhpfastcacheInvalidArgumentException("Can't add a core driver override because its name is empty");
@@ -400,7 +424,7 @@ public static function addCoreDriverOverride(string $driverName, string $classNa
      */
     public static function removeCoreDriverOverride(string $driverName): void
     {
-        $driverName = self::standardizeDriverName($driverName);
+        $driverName = self::normalizeDriverName($driverName);
 
         if (empty($driverName)) {
             throw new PhpfastcacheInvalidArgumentException("Can't remove a core driver override because its name is empty");

lib/Phpfastcache/Config/ConfigurationOption.php

@@ -84,6 +84,14 @@ public function toArray(): array
         return \get_object_vars($this);
     }
 
+    /**
+     * @throws \ReflectionException
+     */
+    public function isValueSerializable(mixed $val): bool
+    {
+        return !\is_callable($val) && !(is_object($val) && (new \ReflectionClass($val))->isAnonymous());
+    }
+
     /**
      * @param string $optionName
      * @return bool

lib/Phpfastcache/Config/ConfigurationOptionInterface.php

@@ -29,6 +29,12 @@ public function __construct(array $parameters = []);
      */
     public function toArray(): array;
 
+    /**
+     * @param mixed $val
+     * @return bool
+     */
+    public function isValueSerializable(mixed $val): bool;
+
     /**
      * @param string $optionName
      * @return bool

lib/Phpfastcache/Drivers/Solr/Config.php

@@ -49,7 +49,7 @@ class Config extends ConfigurationOption
 
     protected array $mappingSchema = self::DEFAULT_MAPPING_SCHEMA;
 
-    private EventDispatcherInterface $eventDispatcher;
+    protected EventDispatcherInterface $eventDispatcher;
 
     public function __construct(array $parameters = [])
     {

lib/Phpfastcache/Drivers/Solr/Driver.php

@@ -109,7 +109,6 @@ protected function driverWrite(ExtendedCacheItemInterface $item): bool
         $update = $this->instance->createUpdate();
 
         $doc = $update->createDocument();
-        /** @SuppressWarnings(PHPMD.UndefinedVariable) */
         $doc->{$this->getSolrField(self::SOLR_DEFAULT_ID_FIELD)} = $item->getEncodedKey();
         $doc->{$this->getSolrField(self::SOLR_DISCRIMINATOR_FIELD)} = self::SOLR_DISCRIMINATOR_VALUE;
         $doc->{$this->getSolrField(self::DRIVER_KEY_WRAPPER_INDEX)} = $item->getKey();

phpstan.neon

@@ -11,6 +11,3 @@ parameters:
 		-
 			message: '#Cannot call method getPayload\(\) on int#' # Issue in predis/predis => https://github.com/predis/predis/pull/710
 			path: lib/Phpfastcache/Drivers/Predis/Driver.php
-		-
-			message: '#Access to an undefined property Solarium\\Core\\Query\\DocumentInterface#' # Issue in predis/predis => https://github.com/predis/predis/pull/710
-			path: lib/Phpfastcache/Drivers/Solr/Driver.php