minor symfony#32143 use proper return types in ErrorHandler and ArgumentResolver (Tobion)

fabpot · fabpot · commit f15722dd84ee · 2019-06-26T09:20:55.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- use proper return types in ErrorHandler and ArgumentResolver | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | tiny | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | | License | MIT | Doc PR | Found those things while reviewing symfony#31996 which missed some return types due to using `return` instead of `return null`. It's part of fixing symfony#17201 (due to symfony#10717). See also symfony#30869 that somebody was stumbling over. Commits ------- 2f9121b use proper return types in ErrorHandler and ArgumentResolver
diff --git a/src/Symfony/Component/Debug/ErrorHandler.php b/src/Symfony/Component/Debug/ErrorHandler.php
@@ -369,18 +369,13 @@ private function reRegister($prev)
     /**
      * Handles errors by filtering then logging them according to the configured bit fields.
      *
-     * @param int    $type    One of the E_* constants
-     * @param string $message
-     * @param string $file
-     * @param int    $line
-     *
      * @return bool Returns false when no handling happens so that the PHP engine can handle the error itself
      *
      * @throws \ErrorException When $this->thrownErrors requests so
      *
      * @internal
      */
-    public function handleError($type, $message, $file, $line)
+    public function handleError(int $type, string $message, string $file, int $line): bool
     {
         // @deprecated to be removed in Symfony 5.0
         if (\PHP_VERSION_ID >= 70300 && $message && '"' === $message[0] && 0 === strpos($message, '"continue') && preg_match('/^"continue(?: \d++)?" targeting switch is equivalent to "break(?: \d++)?"\. Did you mean to use "continue(?: \d++)?"\?$/', $message)) {
@@ -443,7 +438,7 @@ public function handleError($type, $message, $file, $line)
                 self::$silencedErrorCache[$id][$message] = $errorAsException;
             }
             if (null === $lightTrace) {
-                return;
+                return true;
             }
         } else {
             $errorAsException = new \ErrorException($logMessage, 0, $type, $file, $line);
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php
@@ -55,14 +55,16 @@ public function getArguments(Request $request, $controller)
 
                 $resolved = $resolver->resolve($request, $metadata);
 
-                if (!$resolved instanceof \Generator) {
-                    throw new \InvalidArgumentException(sprintf('%s::resolve() must yield at least one value.', \get_class($resolver)));
-                }
-
+                $atLeastOne = false;
                 foreach ($resolved as $append) {
+                    $atLeastOne = true;
                     $arguments[] = $append;
                 }
 
+                if (!$atLeastOne) {
+                    throw new \InvalidArgumentException(sprintf('%s::resolve() must yield at least one value.', \get_class($resolver)));
+                }
+
                 // continue to the next controller argument
                 continue 2;
             }
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/VariadicValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/VariadicValueResolver.php
@@ -41,8 +41,6 @@ public function resolve(Request $request, ArgumentMetadata $argument)
             throw new \InvalidArgumentException(sprintf('The action argument "...$%1$s" is required to be an array, the request attribute "%1$s" contains a type of "%2$s" instead.', $argument->getName(), \gettype($values)));
         }
 
-        foreach ($values as $value) {
-            yield $value;
-        }
+        yield from $values;
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolverInterface.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolverInterface.php
@@ -37,7 +37,7 @@ public function supports(Request $request, ArgumentMetadata $argument);
      * @param Request          $request
      * @param ArgumentMetadata $argument
      *
-     * @return \Generator
+     * @return iterable
      */
     public function resolve(Request $request, ArgumentMetadata $argument);
 }
diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php
@@ -42,30 +42,24 @@ public function createArgumentMetadata($controller)
 
     /**
      * Returns an associated type to the given parameter if available.
-     *
-     * @param \ReflectionParameter $parameter
-     *
-     * @return string|null
      */
-    private function getType(\ReflectionParameter $parameter, \ReflectionFunctionAbstract $function)
+    private function getType(\ReflectionParameter $parameter, \ReflectionFunctionAbstract $function): ?string
     {
         if (!$type = $parameter->getType()) {
-            return;
+            return null;
         }
         $name = $type->getName();
-        $lcName = strtolower($name);
 
-        if ('self' !== $lcName && 'parent' !== $lcName) {
-            return $name;
-        }
-        if (!$function instanceof \ReflectionMethod) {
-            return;
-        }
-        if ('self' === $lcName) {
-            return $function->getDeclaringClass()->name;
-        }
-        if ($parent = $function->getDeclaringClass()->getParentClass()) {
-            return $parent->name;
+        if ($function instanceof \ReflectionMethod) {
+            $lcName = strtolower($name);
+            switch ($lcName) {
+                case 'self':
+                    return $function->getDeclaringClass()->name;
+                case 'parent':
+                    return ($parent = $function->getDeclaringClass()->getParentClass()) ? $parent->name : null;
+            }
         }
+
+        return $name;
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolverTest.php
@@ -185,7 +185,7 @@ public function testGetArgumentWithoutArray()
         $resolver = new ArgumentResolver($factory, [$valueResolver]);
 
         $valueResolver->expects($this->any())->method('supports')->willReturn(true);
-        $valueResolver->expects($this->any())->method('resolve')->willReturn('foo');
+        $valueResolver->expects($this->any())->method('resolve')->willReturn([]);
 
         $request = Request::create('/');
         $request->attributes->set('foo', 'foo');

Original file line number	Diff line number	Diff line change
`@@ -369,18 +369,13 @@ private function reRegister($prev)`
`369`	`369`	`/**`
`370`	`370`	`* Handles errors by filtering then logging them according to the configured bit fields.`
`371`	`371`	`*`
`372`		`- * @param int $type One of the E_* constants`
`373`		`- * @param string $message`
`374`		`- * @param string $file`
`375`		`- * @param int $line`
`376`		`- *`
`377`	`372`	`* @return bool Returns false when no handling happens so that the PHP engine can handle the error itself`
`378`	`373`	`*`
`379`	`374`	`* @throws \ErrorException When $this->thrownErrors requests so`
`380`	`375`	`*`
`381`	`376`	`* @internal`
`382`	`377`	`*/`
`383`		`- public function handleError($type, $message, $file, $line)`
	`378`	`+ public function handleError(int $type, string $message, string $file, int $line): bool`
`384`	`379`	`{`
`385`	`380`	`// @deprecated to be removed in Symfony 5.0`
`386`	`381`	`if (\PHP_VERSION_ID >= 70300 && $message && '"' === $message[0] && 0 === strpos($message, '"continue') && preg_match('/^"continue(?: \d++)?" targeting switch is equivalent to "break(?: \d++)?"\. Did you mean to use "continue(?: \d++)?"\?$/', $message)) {`
`@@ -443,7 +438,7 @@ public function handleError($type, $message, $file, $line)`
`443`	`438`	`self::$silencedErrorCache[$id][$message] = $errorAsException;`
`444`	`439`	`}`
`445`	`440`	`if (null === $lightTrace) {`
`446`		`- return;`
	`441`	`+ return true;`
`447`	`442`	`}`
`448`	`443`	`} else {`
`449`	`444`	`$errorAsException = new \ErrorException($logMessage, 0, $type, $file, $line);`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,6 @@ public function resolve(Request $request, ArgumentMetadata $argument)`
`41`	`41`	`throw new \InvalidArgumentException(sprintf('The action argument "...$%1$s" is required to be an array, the request attribute "%1$s" contains a type of "%2$s" instead.', $argument->getName(), \gettype($values)));`
`42`	`42`	`}`
`43`	`43`
`44`		`- foreach ($values as $value) {`
`45`		`- yield $value;`
`46`		`- }`
	`44`	`+ yield from $values;`
`47`	`45`	`}`
`48`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function supports(Request $request, ArgumentMetadata $argument);`
`37`	`37`	`* @param Request $request`
`38`	`38`	`* @param ArgumentMetadata $argument`
`39`	`39`	`*`
`40`		`- * @return \Generator`
	`40`	`+ * @return iterable`
`41`	`41`	`*/`
`42`	`42`	`public function resolve(Request $request, ArgumentMetadata $argument);`
`43`	`43`	`}`