- Updated strictly return type hints in CacheManager

Geolim4 · Geolim4 · commit 4c8ab7564ad2 · 2018-03-17T00:34:13.000+01:00
- Added CacheManager::getDriverList()
- Added PhpfastcacheUnsupportedOperationException exception
- Added deprecation section in migrating guide
- Deprecated CacheManager::getStaticAllDrivers()
- Deprecated CacheManager::getStaticSystemDrivers()
- Deprecated configuration option "ignoreSymfonyNotice"
diff --git a/docs/migration/MigratingFromV6ToV7.md b/docs/migration/MigratingFromV6ToV7.md
@@ -21,6 +21,11 @@ The time has changed, you now have to use: `class PhpfastcacheAbstractProxy`
 For any useful purpose, all the PhpFastCache exceptions has been **C**apitalized.
 Class `Phpfastcache\Exceptions\phpFastCache[...]Exception` have been renamed to `Phpfastcache\Exceptions\Phpfastcache[...]Exception`
 
+### Deprecations
+- `Phpfastcache\CacheManager::getStaticAllDrivers()` replaced by `Phpfastcache\CacheManager::getDriverList()`
+- `Phpfastcache\CacheManager::getStaticSystemDrivers()` replaced by `Phpfastcache\CacheManager::getDriverList()`
+- Configuration option `ignoreSymfonyNotice` will not be replaced since that the related Symfony notice in `Phpfastcache\CacheManager::getInstance()` has been removed
+
 ### Return type & Scalar type declarations 
 :anger: :exclamation: The V7 will make use of new php's return type & scalars type declarations features. 
 This means that you will now have to be very careful about the data types that you are sending to the phpFastCache API.
@@ -146,4 +151,3 @@ The API changelog used to be hardcoded as a HEREDOC in the `Api::getChangelog()`
 The API changelog format has been moved to a MarDown file (.md)
 If you were using `Api::getChangelog()` you may need to check that your code is still working as expected.
 The method still returns a valid string but its format has changed slightly.
-
diff --git a/lib/Phpfastcache/CacheManager.php b/lib/Phpfastcache/CacheManager.php
@@ -18,8 +18,9 @@
 use Phpfastcache\Config\ConfigurationOption;
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Exceptions\{
-  PhpfastcacheDeprecatedException, PhpfastcacheDriverCheckException, PhpfastcacheDriverNotFoundException, PhpfastcacheInstanceNotFoundException, PhpfastcacheInvalidArgumentException, PhpfastcacheInvalidConfigurationException
+  PhpfastcacheDeprecatedException, PhpfastcacheDriverCheckException, PhpfastcacheDriverNotFoundException, PhpfastcacheInstanceNotFoundException, PhpfastcacheInvalidArgumentException, PhpfastcacheInvalidConfigurationException, PhpfastcacheLogicException, PhpfastcacheUnsupportedOperationException
 };
+use Phpfastcache\Util\ClassNamespaceResolverTrait;
 
 /**
  * Class CacheManager
@@ -51,6 +52,8 @@
  */
 class CacheManager
 {
+    use ClassNamespaceResolverTrait;
+
     /**
      * @var ConfigurationOption
      */
@@ -88,7 +91,7 @@ class CacheManager
      * @throws PhpfastcacheDriverNotFoundException
      * @throws PhpfastcacheInvalidArgumentException
      */
-    public static function getInstance($driver = 'auto', $config = null, $instanceId = null)
+    public static function getInstance($driver = 'auto', $config = null, $instanceId = null): ExtendedCacheItemPoolInterface
     {
         static $badPracticeOmeter = [];
 
@@ -202,17 +205,17 @@ public static function &getInternalInstances(): array
     }
 
     /**
-     * @todo Does we really keep it ??
-     * @param $config
+     * @param ConfigurationOption $config
      * @return string
      * @throws PhpfastcacheDriverCheckException
+     * @throws \Phpfastcache\Exceptions\PhpfastcacheLogicException
      */
-    public static function getAutoClass(array $config = [])
+    public static function getAutoClass(ConfigurationOption $config): string
     {
         static $autoDriver;
 
         if ($autoDriver === null) {
-            foreach (self::getStaticSystemDrivers() as $driver) {
+            foreach (self::getDriverList() as $driver) {
                 try {
                     self::getInstance($driver, $config);
                     $autoDriver = $driver;
@@ -223,15 +226,19 @@ public static function getAutoClass(array $config = [])
             }
         }
 
+        if(!$autoDriver || !\is_string($autoDriver)){
+            throw new PhpfastcacheLogicException('Unable to find out a valid driver automatically');
+        }
+
         return $autoDriver;
     }
 
     /**
      * @param string $name
      * @param array $arguments
-     * @return \Psr\Cache\CacheItemPoolInterface
+     * @return \Psr\Cache\ExtendedCacheItemPoolInterface
      */
-    public static function __callStatic($name, $arguments)
+    public static function __callStatic(string $name, array $arguments): ExtendedCacheItemPoolInterface
     {
         $options = (\array_key_exists(0, $arguments) && \is_array($arguments) ? $arguments[ 0 ] : []);
 
@@ -241,7 +248,7 @@ public static function __callStatic($name, $arguments)
     /**
      * @return bool
      */
-    public static function clearInstances()
+    public static function clearInstances(): bool
     {
         self::$instances = [];
 
@@ -252,9 +259,17 @@ public static function clearInstances()
     /**
      * @return string
      */
-    public static function getNamespacePath()
+    public static function getNamespacePath(): string
+    {
+        return self::$namespacePath ?: self::getDefaultNamespacePath();
+    }
+
+    /**
+     * @return string
+     */
+    public static function getDefaultNamespacePath(): string
     {
-        return self::$namespacePath ?: __NAMESPACE__ . '\Drivers\\';
+        return  __NAMESPACE__ . '\Drivers\\';
     }
 
     /**
@@ -283,12 +298,11 @@ public static function getDefaultConfig(): ConfigurationOption
 
     /**
      * @return array
+     * @deprecated As of V7 will be removed soon or later, use CacheManager::getDriverList() instead
      */
-    public static function getStaticSystemDrivers()
+    public static function getStaticSystemDrivers(): array
     {
-        /**
-         * @todo Reflection reader
-         */
+        trigger_error(sprintf('Method "%s" is deprecated as of the V7 and will be removed soon or later, use CacheManager::getDriverList() instead.', __METHOD__), E_USER_DEPRECATED);
         return [
           'Apc',
           'Apcu',
@@ -316,19 +330,45 @@ public static function getStaticSystemDrivers()
 
     /**
      * @return array
+     * @deprecated As of V7 will be removed soon or later, use CacheManager::getDriverList() instead
      */
-    public static function getStaticAllDrivers()
+    public static function getStaticAllDrivers(): array
     {
-        /**
-         * @todo Reflection reader
-         */
+        trigger_error(sprintf('Method "%s" is deprecated as of the V7 and will be removed soon or later, use CacheManager::getDriverList() instead.', __METHOD__), E_USER_DEPRECATED);
         return \array_merge(self::getStaticSystemDrivers(), [
           'Devtrue',
           'Devfalse',
           'Cookie',
         ]);
     }
 
+    /**
+     * @return string[]
+     * @throws PhpfastcacheUnsupportedOperationException
+     */
+    public static function getDriverList(): array
+    {
+        static $driverList;
+
+        if(self::getDefaultNamespacePath() === self::getNamespacePath()){
+            if($driverList === null){
+                $prefix = 'Phpfastcache\Drivers\\';
+                $classMap = self::createClassMap(__DIR__ . '/Drivers');
+                $driverList = [];
+
+                foreach ($classMap as $class => $file) {
+                    $driverList[] = str_replace($prefix, '', substr($class, 0, strrpos($class, '\\') ));
+                }
+
+                $driverList = array_values(array_unique($driverList));
+            }
+
+            return $driverList;
+        }
+
+        throw new PhpfastcacheUnsupportedOperationException('Cannot get the driver list if the default namespace path has changed.');
+    }
+
     /**
      * @param string $driverName
      * @return string
diff --git a/lib/Phpfastcache/Config/ConfigurationOption.php b/lib/Phpfastcache/Config/ConfigurationOption.php
@@ -200,15 +200,18 @@ public function setAutoTmpFallback(bool $autoTmpFallback): self
 
     /**
      * @return bool
+     * @deprecated As of V7
      */
     public function isIgnoreSymfonyNotice(): bool
     {
+
         return $this->ignoreSymfonyNotice;
     }
 
     /**
      * @param bool $ignoreSymfonyNotice
      * @return ConfigurationOption
+     * @deprecated As of V7
      */
     public function setIgnoreSymfonyNotice(bool $ignoreSymfonyNotice): self
     {
diff --git a/lib/Phpfastcache/Exceptions/PhpfastcacheUnsupportedOperationException.php b/lib/Phpfastcache/Exceptions/PhpfastcacheUnsupportedOperationException.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ *
+ * This file is part of phpFastCache.
+ *
+ * @license MIT License (MIT)
+ *
+ * For full copyright and license information, please see the docs/CREDITS.txt file.
+ *
+ * @author Khoa Bui (khoaofgod)  <khoaofgod@gmail.com> http://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ *
+ */
+declare(strict_types=1);
+
+namespace Phpfastcache\Exceptions;
+
+/**
+ * Class PhpfastcacheUnsupportedOperationException
+ * @package Phpfastcache\Exceptions
+ */
+class PhpfastcacheUnsupportedOperationException extends PhpfastcacheRootException
+{
+
+}
diff --git a/lib/Phpfastcache/Util/ClassNamespaceResolverTrait.php b/lib/Phpfastcache/Util/ClassNamespaceResolverTrait.php
@@ -29,12 +29,122 @@ trait ClassNamespaceResolverTrait
     /**
      * @return string
      */
-    protected function getClassNamespace()
+    protected function getClassNamespace(): string
     {
         if (!$this->namespace) {
             $this->namespace = \substr(static::class, 0, strrpos(static::class, '\\'));
         }
 
         return $this->namespace;
     }
+
+    /**
+     * Iterate over all files in the given directory searching for classes.
+     *
+     * NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they
+     * deprecated the whole component as of SF4. Our thanks to them.
+     *
+     * @param \Iterator|string|array $dir The directory to search in or an iterator
+     *
+     * @return array A class map array
+     */
+    protected static function createClassMap($dir): array
+    {
+        if (\is_string($dir)) {
+            $dir = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir));
+        }
+        $map = [];
+
+        if(\is_array($dir) || $dir instanceof \Traversable){
+            foreach ($dir as $file) {
+                if (!$file->isFile()) {
+                    continue;
+                }
+                $path = $file->getRealPath() ?: $file->getPathname();
+                if ('php' !== pathinfo($path, PATHINFO_EXTENSION)) {
+                    continue;
+                }
+                $classes = self::findClasses($path);
+                if (\PHP_VERSION_ID >= 70000) {
+                    // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
+                    gc_mem_caches();
+                }
+                foreach ($classes as $class) {
+                    $map[ $class ] = $path;
+                }
+            }
+        }
+
+        return $map;
+    }
+
+    /**
+     * Extract the classes in the given file.
+     *
+     * NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they
+     * deprecated the whole component as of SF4. Our thanks to them.
+     *
+     * @param string $path The file to check
+     *
+     * @return array The found classes
+     */
+    protected static function findClasses(string $path): array
+    {
+        $contents = file_get_contents($path);
+        $tokens = token_get_all($contents);
+        $classes = [];
+        $namespace = '';
+        for ($i = 0; isset($tokens[ $i ]); ++$i) {
+            $token = $tokens[ $i ];
+            if (!isset($token[ 1 ])) {
+                continue;
+            }
+            $class = '';
+            switch ($token[ 0 ]) {
+                case T_NAMESPACE:
+                    $namespace = '';
+                    // If there is a namespace, extract it
+                    while (isset($tokens[ ++$i ][ 1 ])) {
+                        if (in_array($tokens[ $i ][ 0 ], [T_STRING, T_NS_SEPARATOR])) {
+                            $namespace .= $tokens[ $i ][ 1 ];
+                        }
+                    }
+                    $namespace .= '\\';
+                    break;
+                case T_CLASS:
+                case T_INTERFACE:
+                case T_TRAIT:
+                    // Skip usage of ::class constant
+                    $isClassConstant = false;
+                    for ($j = $i - 1; $j > 0; --$j) {
+                        if (!isset($tokens[ $j ][ 1 ])) {
+                            break;
+                        }
+                        if (T_DOUBLE_COLON === $tokens[ $j ][ 0 ]) {
+                            $isClassConstant = true;
+                            break;
+                        } elseif (!\in_array($tokens[ $j ][ 0 ], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT], false)) {
+                            break;
+                        }
+                    }
+                    if ($isClassConstant) {
+                        break;
+                    }
+                    // Find the classname
+                    while (isset($tokens[ ++$i ][ 1 ])) {
+                        $t = $tokens[ $i ];
+                        if (T_STRING === $t[ 0 ]) {
+                            $class .= $t[ 1 ];
+                        } elseif ('' !== $class && T_WHITESPACE === $t[ 0 ]) {
+                            break;
+                        }
+                    }
+                    $classes[] = ltrim($namespace . $class, '\\');
+                    break;
+                default:
+                    break;
+            }
+        }
+        return $classes;
+    }
 }
diff --git a/tests/DriverListResolver.test.php b/tests/DriverListResolver.test.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <khoaofgod@gmail.com> http://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ */
+
+use Phpfastcache\CacheManager;
+use Phpfastcache\Helper\TestHelper;
+
+chdir(__DIR__);
+require_once __DIR__ . '/../lib/Phpfastcache/Autoload/Autoload.php';
+$testHelper = new TestHelper('Driver list resolver');
+
+$subClasses = [
+  'Config',
+  'Driver',
+  'Item',
+];
+
+$driverList = CacheManager::getDriverList();
+
+foreach ($driverList as $driver) {
+    foreach ($subClasses as $subClass) {
+        $className = "Phpfastcache\\Drivers\\{$driver}\\{$subClass}";
+        if(class_exists($className)){
+            $testHelper->printPassText(sprintf('Found the %s %s class: "%s"', $driver, $subClass, $className));
+        }else{
+            $testHelper->printFailText(sprintf('Class "%s" not found', $className));
+        }
+    }
+}
+
+$testHelper->terminateTest();

Original file line number	Diff line number	Diff line change
`@@ -200,15 +200,18 @@ public function setAutoTmpFallback(bool $autoTmpFallback): self`
`200`	`200`
`201`	`201`	`/**`
`202`	`202`	`* @return bool`
	`203`	`+ * @deprecated As of V7`
`203`	`204`	`*/`
`204`	`205`	`public function isIgnoreSymfonyNotice(): bool`
`205`	`206`	`{`
	`207`	`+`
`206`	`208`	`return $this->ignoreSymfonyNotice;`
`207`	`209`	`}`
`208`	`210`
`209`	`211`	`/**`
`210`	`212`	`* @param bool $ignoreSymfonyNotice`
`211`	`213`	`* @return ConfigurationOption`
	`214`	`+ * @deprecated As of V7`
`212`	`215`	`*/`
`213`	`216`	`public function setIgnoreSymfonyNotice(bool $ignoreSymfonyNotice): self`
`214`	`217`	`{`