Refine types for InputFilterPluginManager::get and add additional S…

…A test The return type union of `InputInterface|InputFilterInterface` is problematic in Psalm, so it has been "simplified" into 2 templates and a nested return conditional to ensure the expected return type in each of the 3 expected input types. Template constraints and Unions do not appear to work when used in a parameterised class-string, so `class-string<T1|T2>` is problematic as is `class-string<FQCNa|FQCNb>`, as is `class-string<T>` where `T` = `FQCNa|FQCNb` Signed-off-by: George Steel <[email protected]>
laminas · Jan 10, 2024 · 765bebb · 765bebb
1 parent 68627d4
commit 765bebb
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -282,7 +282,7 @@
       <code>get</code>
     </MethodSignatureMustProvideReturnType>
     <MixedInferredReturnType>
-      <code><![CDATA[($name is class-string<T> ? T : InputInterface|InputFilterInterface)]]></code>
+      <code><![CDATA[($name is class-string<InputInterface> ? T1 : ($name is class-string<InputFilterInterface> ? T2 : InputInterface|InputFilterInterface))]]></code>
     </MixedInferredReturnType>
     <MixedReturnStatement>
       <code>parent::get($name, $options)</code>

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -28,6 +28,11 @@
                 <directory name="test/StaticAnalysis" />
             </errorLevel>
         </UnusedClass>
+        <PossiblyUnusedMethod>
+            <errorLevel type="suppress">
+                <directory name="test/StaticAnalysis" />
+            </errorLevel>
+        </PossiblyUnusedMethod>
     </issueHandlers>
 
     <stubs>

diff --git a/src/InputFilterPluginManager.php b/src/InputFilterPluginManager.php
@@ -190,9 +190,12 @@ public function validatePlugin($plugin)
 
     /**
      * @inheritDoc
-     * @template T of InputInterface|InputFilterInterface
-     * @param class-string<T>|string $name
-     * @return ($name is class-string<T> ? T : InputInterface|InputFilterInterface)
+     * phpcs:disable Generic.Files.LineLength.TooLong
+     * // Template constraint required or we get mixed added to output. Two templates because union does not work
+     * @template T1 of InputInterface
+     * @template T2 of InputFilterInterface
+     * @param class-string<T1>|class-string<T2>|string $name
+     * @return ($name is class-string<InputInterface> ? T1 : ($name is class-string<InputFilterInterface> ? T2 : InputInterface|InputFilterInterface))
      */
     public function get($name, ?array $options = null)
     {

diff --git a/test/StaticAnalysis/InputFilterPluginManagerType.php b/test/StaticAnalysis/InputFilterPluginManagerType.php
@@ -24,4 +24,9 @@ public function getWithFQCNWillReturnTheObjectOfType(): InputFilterWithTemplated
     {
         return $this->manager->get(InputFilterWithTemplatedValues::class);
     }
+
+    public function getInvalidFQCNReturnsFallbackType(): InputInterface|InputFilterInterface
+    {
+        return $this->manager->get(self::class);
+    }
 }