bug #45043 [ErrorHandler] ignore @return when there is an @template (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 326944d46736 · 2022-03-18T17:21:29.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [ErrorHandler] ignore ``@return`` when there is an ``@template`` | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - And update .github/expected-missing-return-types.diff Commits ------- d1aa509 [ErrorHandler] ignore ``@return`` when there is an ``@template``
diff --git a/src/Symfony/Component/ErrorHandler/DebugClassLoader.php b/src/Symfony/Component/ErrorHandler/DebugClassLoader.php
@@ -368,9 +368,12 @@ public function checkAnnotations(\ReflectionClass $refl, string $class): array
 
         $parent = get_parent_class($class) ?: null;
         self::$returnTypes[$class] = [];
+        $classIsTemplate = false;
 
         // Detect annotations on the class
         if ($doc = $this->parsePhpDoc($refl)) {
+            $classIsTemplate = isset($doc['template']);
+
             foreach (['final', 'deprecated', 'internal'] as $annotation) {
                 if (null !== $description = $doc[$annotation][0] ?? null) {
                     self::${$annotation}[$class] = '' !== $description ? ' '.$description.(preg_match('/[.!]$/', $description) ? '' : '.') : '.';
@@ -514,6 +517,10 @@ public function checkAnnotations(\ReflectionClass $refl, string $class): array
             // To read method annotations
             $doc = $this->parsePhpDoc($method);
 
+            if (($classIsTemplate || isset($doc['template'])) && $method->hasReturnType()) {
+                unset($doc['return']);
+            }
+
             if (isset(self::$annotatedParameters[$class][$method->name])) {
                 $definedParameters = [];
                 foreach ($method->getParameters() as $parameter) {
