Enable CacheFactory::getHandler() return type extension

Author: paulbalandan

docs/type-inference.md

@@ -128,3 +128,23 @@ This extension provides precise return type for the static `getSharedInstance()`
 >     additionalServices:
 >       - Acme\Blog\Config\Services
 > ```
+
+### CacheFactoryGetHandlerReturnTypeExtension
+
+**Class:** `CodeIgniter\PHPStan\Type\CacheFactoryGetHandlerReturnTypeExtension`
+
+This extension provides precise return types for the static `CacheFactory::getHandler()` method, resolving
+the handler class from the `validHandlers` of the passed `Config\Cache` and the requested handler and backup
+handler names.
+
+> [!NOTE]
+> **Configuration:**
+>
+> By default, only the resolved primary handler is used as the return type. To also include the backup handler
+> in the inferred return type, enable:
+>
+> ```yml
+> parameters:
+>   codeigniter:
+>     addBackupHandlerAsReturnType: true
+> ```

extension.neon

@@ -10,6 +10,7 @@ parameters:
       - CodeIgniter\Config\
     additionalModelNamespaces: []
     additionalServices: []
+    addBackupHandlerAsReturnType: false
     checkArgumentTypeOfConfig: true
     checkArgumentTypeOfModel: true
     checkArgumentTypeOfFactories: true
@@ -19,6 +20,7 @@ parametersSchema:
     additionalConfigNamespaces: listOf(string())
     additionalModelNamespaces: listOf(string())
     additionalServices: listOf(string())
+    addBackupHandlerAsReturnType: bool()
     checkArgumentTypeOfConfig: bool()
     checkArgumentTypeOfModel: bool()
     checkArgumentTypeOfFactories: bool()
@@ -86,6 +88,13 @@ services:
     tags:
       - phpstan.broker.dynamicStaticMethodReturnTypeExtension
 
+  -
+    class: CodeIgniter\PHPStan\Type\CacheFactoryGetHandlerReturnTypeExtension
+    arguments:
+      addBackupHandlerAsReturnType: %codeigniter.addBackupHandlerAsReturnType%
+    tags:
+      - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+
   -
     class: CodeIgniter\PHPStan\Rules\Functions\FactoriesFunctionArgumentTypeRule
     arguments:

tests/Type/data/cache-factory.php …inference/cache-factory-return-types.phptests/Type/data/cache-factory.php renamed to tests/data/type-inference/cache-factory-return-types.php tests/Type/data/cache-factory.php renamed to tests/data/type-inference/cache-factory-return-types.php

@@ -11,9 +11,10 @@
  * the LICENSE file that was distributed with this source code.
  */
 
-namespace CodeIgniter\PHPStan\Tests\Fixtures\Type;
+namespace CodeIgniter\PHPStan\Tests\Type;
 
 use CodeIgniter\Cache\CacheFactory;
+use CodeIgniter\Cache\Handlers\ApcuHandler;
 use CodeIgniter\Cache\Handlers\BaseHandler;
 use CodeIgniter\Cache\Handlers\DummyHandler;
 use CodeIgniter\Cache\Handlers\FileHandler;
@@ -29,6 +30,7 @@
 assertType(FileHandler::class, CacheFactory::getHandler($cache));
 assertType(FileHandler::class, CacheFactory::getHandler($cache, null));
 
+assertType(ApcuHandler::class, CacheFactory::getHandler($cache, 'apcu'));
 assertType(DummyHandler::class, CacheFactory::getHandler($cache, 'dummy'));
 assertType(FileHandler::class, CacheFactory::getHandler($cache, 'file'));
 assertType(MemcachedHandler::class, CacheFactory::getHandler($cache, 'memcached'));