Fix support for PHP8 union types

nicolas-grekas · nicolas-grekas · commit da68e66a9913 · 2020-06-18T19:59:13.000+02:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/CheckTypeDeclarationsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/CheckTypeDeclarationsPass.php
@@ -153,9 +153,26 @@ private function checkTypeDeclarations(Definition $checkedDefinition, \Reflectio
     /**
      * @throws InvalidParameterTypeException When a parameter is not compatible with the declared type
      */
-    private function checkType(Definition $checkedDefinition, $value, \ReflectionParameter $parameter, ?string $envPlaceholderUniquePrefix): void
+    private function checkType(Definition $checkedDefinition, $value, \ReflectionParameter $parameter, ?string $envPlaceholderUniquePrefix, string $type = null): void
     {
-        $type = $parameter->getType()->getName();
+        if (null === $type) {
+            $type = $parameter->getType();
+
+            if ($type instanceof \ReflectionUnionType) {
+                foreach ($type->getTypes() as $type) {
+                    try {
+                        $this->checkType($checkedDefinition, $value, $parameter, $envPlaceholderUniquePrefix, $type);
+
+                        return;
+                    } catch (InvalidParameterTypeException $e) {
+                    }
+                }
+
+                throw new InvalidParameterTypeException($this->currentId, $e->getCode(), $parameter);
+            }
+
+            $type = $type->getName();
+        }
 
         if ($value instanceof Reference) {
             if (!$this->container->has($value = (string) $value)) {
@@ -266,7 +283,7 @@ private function checkType(Definition $checkedDefinition, $value, \ReflectionPar
             return;
         }
 
-        $checkFunction = sprintf('is_%s', $parameter->getType()->getName());
+        $checkFunction = sprintf('is_%s', $type);
 
         if (!$parameter->getType()->isBuiltin() || !$checkFunction($value)) {
             throw new InvalidParameterTypeException($this->currentId, \is_object($value) ? $class : \gettype($value), $parameter);
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/Preloader.php b/src/Symfony/Component/DependencyInjection/Dumper/Preloader.php
@@ -48,7 +48,7 @@ public static function preload(array $classes)
         }
     }
 
-    private static function doPreload(string $class, array &$preloaded)
+    private static function doPreload(string $class, array &$preloaded): void
     {
         if (isset($preloaded[$class]) || \in_array($class, ['self', 'static', 'parent'], true)) {
             return;
@@ -68,9 +68,7 @@ private static function doPreload(string $class, array &$preloaded)
 
             if (\PHP_VERSION_ID >= 70400) {
                 foreach ($r->getProperties(\ReflectionProperty::IS_PUBLIC) as $p) {
-                    if (($t = $p->getType()) && !$t->isBuiltin()) {
-                        self::doPreload($t->getName(), $preloaded);
-                    }
+                    self::preloadType($p->getType(), $preloaded);
                 }
             }
 
@@ -84,17 +82,26 @@ private static function doPreload(string $class, array &$preloaded)
                         }
                     }
 
-                    if (($t = $p->getType()) && !$t->isBuiltin()) {
-                        self::doPreload($t->getName(), $preloaded);
-                    }
+                    self::preloadType($p->getType(), $preloaded);
                 }
 
-                if (($t = $m->getReturnType()) && !$t->isBuiltin()) {
-                    self::doPreload($t->getName(), $preloaded);
-                }
+                self::preloadType($p->getReturnType(), $preloaded);
             }
         } catch (\ReflectionException $e) {
             // ignore missing classes
         }
     }
+
+    private static function preloadType(?\ReflectionType $t, array &$preloaded): void
+    {
+        if (!$t || $t->isBuiltin()) {
+            return;
+        }
+
+        foreach ($t instanceof \ReflectionUnionType ? $t->getTypes() : [$t] as $t) {
+            if (!$t->isBuiltin()) {
+                self::doPreload($t instanceof \ReflectionNamedType ? $t->getName() : $t, $preloaded);
+            }
+        }
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Exception/InvalidParameterTypeException.php b/src/Symfony/Component/DependencyInjection/Exception/InvalidParameterTypeException.php
@@ -21,6 +21,9 @@ class InvalidParameterTypeException extends InvalidArgumentException
 {
     public function __construct(string $serviceId, string $type, \ReflectionParameter $parameter)
     {
-        parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s::%s" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $parameter->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), $parameter->getType()->getName(), $type));
+        $acceptedType = $parameter->getType();
+        $acceptedType = $acceptedType instanceof \ReflectionNamedType ? $acceptedType->getName() : (string) $acceptedType;
+
+        parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s::%s" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $parameter->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), $acceptedType, $type), $type);
     }
 }
diff --git a/src/Symfony/Component/EventDispatcher/DependencyInjection/RegisterListenersPass.php b/src/Symfony/Component/EventDispatcher/DependencyInjection/RegisterListenersPass.php
@@ -138,7 +138,7 @@ private function getEventFromTypeDeclaration(ContainerBuilder $container, string
             || !($r = $container->getReflectionClass($class, false))
             || !$r->hasMethod($method)
             || 1 > ($m = $r->getMethod($method))->getNumberOfParameters()
-            || !($type = $m->getParameters()[0]->getType())
+            || !($type = $m->getParameters()[0]->getType()) instanceof \ReflectionNamedType
             || $type->isBuiltin()
             || Event::class === ($name = $type->getName())
             || LegacyEvent::class === $name
diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php
@@ -45,7 +45,7 @@ public function createArgumentMetadata($controller): array
      */
     private function getType(\ReflectionParameter $parameter, \ReflectionFunctionAbstract $function): ?string
     {
-        if (!$type = $parameter->getType()) {
+        if (!($type = $parameter->getType()) instanceof \ReflectionNamedType) {
             return null;
         }
         $name = $type->getName();
diff --git a/src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php b/src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php
@@ -99,7 +99,7 @@ public function onControllerArguments(ControllerArgumentsEvent $event)
         $r = new \ReflectionFunction(\Closure::fromCallable($event->getController()));
         $r = $r->getParameters()[$k] ?? null;
 
-        if ($r && (!$r->hasType() || \in_array($r->getType()->getName(), [FlattenException::class, LegacyFlattenException::class], true))) {
+        if ($r && (!($r = $r->getType()) instanceof \ReflectionNamedType || \in_array($r->getName(), [FlattenException::class, LegacyFlattenException::class], true))) {
             $arguments = $event->getArguments();
             $arguments[$k] = FlattenException::createFromThrowable($e);
             $event->setArguments($arguments);
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -228,11 +228,24 @@ private function guessHandledClasses(\ReflectionClass $handlerClass, string $ser
             throw new RuntimeException(sprintf('Invalid handler service "%s": argument "$%s" of method "%s::__invoke()" must have a type-hint corresponding to the message class it handles.', $serviceId, $parameters[0]->getName(), $handlerClass->getName()));
         }
 
+        if ($type instanceof \ReflectionUnionType) {
+            $types = [];
+            foreach ($type->getTypes() as $type) {
+                if (!$type->isBuiltin()) {
+                    $types[] = (string) $type;
+                }
+            }
+
+            if ($types) {
+                return $types;
+            }
+        }
+
         if ($type->isBuiltin()) {
             throw new RuntimeException(sprintf('Invalid handler service "%s": type-hint of argument "$%s" in method "%s::__invoke()" must be a class , "%s" given.', $serviceId, $parameters[0]->getName(), $handlerClass->getName(), $type instanceof \ReflectionNamedType ? $type->getName() : (string) $type));
         }
 
-        return [$parameters[0]->getType()->getName()];
+        return [$type->getName()];
     }
 
     private function registerReceivers(ContainerBuilder $container, array $busIds)
diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php
@@ -201,7 +201,7 @@ public function setDefault($option, $value)
                 return $this;
             }
 
-            if (isset($params[0]) && null !== ($type = $params[0]->getType()) && self::class === $type->getName() && (!isset($params[1]) || (null !== ($type = $params[1]->getType()) && Options::class === $type->getName()))) {
+            if (isset($params[0]) && null !== ($type = $params[0]->getType()) && self::class === $type->getName() && (!isset($params[1]) || (($type = $params[1]->getType()) instanceof \ReflectionNamedType && Options::class === $type->getName()))) {
                 // Store closure for later evaluation
                 $this->nested[$option][] = $value;
                 $this->defaults[$option] = [];
diff --git a/src/Symfony/Contracts/Service/ServiceLocatorTrait.php b/src/Symfony/Contracts/Service/ServiceLocatorTrait.php
@@ -87,7 +87,7 @@ public function getProvidedServices(): array
                 } else {
                     $type = (new \ReflectionFunction($factory))->getReturnType();
 
-                    $this->providedTypes[$name] = $type ? ($type->allowsNull() ? '?' : '').$type->getName() : '?';
+                    $this->providedTypes[$name] = $type ? ($type->allowsNull() ? '?' : '').($type instanceof \ReflectionNamedType ? $type->getName() : $type) : '?';
                 }
             }
         }
diff --git a/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php b/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php
@@ -40,7 +40,7 @@ public static function getSubscribedServices(): array
             }
 
             if (self::class === $method->getDeclaringClass()->name && ($returnType = $method->getReturnType()) && !$returnType->isBuiltin()) {
-                $services[self::class.'::'.$method->name] = '?'.$returnType->getName();
+                $services[self::class.'::'.$method->name] = '?'.($returnType instanceof \ReflectionNamedType ? $returnType->getName() : $type);
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public static function preload(array $classes)`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
`51`		`- private static function doPreload(string $class, array &$preloaded)`
	`51`	`+ private static function doPreload(string $class, array &$preloaded): void`
`52`	`52`	`{`
`53`	`53`	`if (isset($preloaded[$class]) \|\| \in_array($class, ['self', 'static', 'parent'], true)) {`
`54`	`54`	`return;`
`@@ -68,9 +68,7 @@ private static function doPreload(string $class, array &$preloaded)`
`68`	`68`
`69`	`69`	`if (\PHP_VERSION_ID >= 70400) {`
`70`	`70`	`foreach ($r->getProperties(\ReflectionProperty::IS_PUBLIC) as $p) {`
`71`		`- if (($t = $p->getType()) && !$t->isBuiltin()) {`
`72`		`- self::doPreload($t->getName(), $preloaded);`
`73`		`- }`
	`71`	`+ self::preloadType($p->getType(), $preloaded);`
`74`	`72`	`}`
`75`	`73`	`}`
`76`	`74`
`@@ -84,17 +82,26 @@ private static function doPreload(string $class, array &$preloaded)`
`84`	`82`	`}`
`85`	`83`	`}`
`86`	`84`
`87`		`- if (($t = $p->getType()) && !$t->isBuiltin()) {`
`88`		`- self::doPreload($t->getName(), $preloaded);`
`89`		`- }`
	`85`	`+ self::preloadType($p->getType(), $preloaded);`
`90`	`86`	`}`
`91`	`87`
`92`		`- if (($t = $m->getReturnType()) && !$t->isBuiltin()) {`
`93`		`- self::doPreload($t->getName(), $preloaded);`
`94`		`- }`
	`88`	`+ self::preloadType($p->getReturnType(), $preloaded);`
`95`	`89`	`}`
`96`	`90`	`} catch (\ReflectionException $e) {`
`97`	`91`	`// ignore missing classes`
`98`	`92`	`}`
`99`	`93`	`}`
	`94`	`+`
	`95`	`+ private static function preloadType(?\ReflectionType $t, array &$preloaded): void`
	`96`	`+ {`
	`97`	`+ if (!$t \|\| $t->isBuiltin()) {`
	`98`	`+ return;`
	`99`	`+ }`
	`100`	`+`
	`101`	`+ foreach ($t instanceof \ReflectionUnionType ? $t->getTypes() : [$t] as $t) {`
	`102`	`+ if (!$t->isBuiltin()) {`
	`103`	`+ self::doPreload($t instanceof \ReflectionNamedType ? $t->getName() : $t, $preloaded);`
	`104`	`+ }`
	`105`	`+ }`
	`106`	`+ }`
`100`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,9 @@ class InvalidParameterTypeException extends InvalidArgumentException`
`21`	`21`	`{`
`22`	`22`	`public function __construct(string $serviceId, string $type, \ReflectionParameter $parameter)`
`23`	`23`	`{`
`24`		`- parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s::%s" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $parameter->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), $parameter->getType()->getName(), $type));`
	`24`	`+ $acceptedType = $parameter->getType();`
	`25`	`+ $acceptedType = $acceptedType instanceof \ReflectionNamedType ? $acceptedType->getName() : (string) $acceptedType;`
	`26`	`+`
	`27`	`+ parent::__construct(sprintf('Invalid definition for service "%s": argument %d of "%s::%s" accepts "%s", "%s" passed.', $serviceId, 1 + $parameter->getPosition(), $parameter->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), $acceptedType, $type), $type);`
`25`	`28`	`}`
`26`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function createArgumentMetadata($controller): array`
`45`	`45`	`*/`
`46`	`46`	`private function getType(\ReflectionParameter $parameter, \ReflectionFunctionAbstract $function): ?string`
`47`	`47`	`{`
`48`		`- if (!$type = $parameter->getType()) {`
	`48`	`+ if (!($type = $parameter->getType()) instanceof \ReflectionNamedType) {`
`49`	`49`	`return null;`
`50`	`50`	`}`
`51`	`51`	`$name = $type->getName();`
Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ public function setDefault($option, $value)`
`201`	`201`	`return $this;`
`202`	`202`	`}`
`203`	`203`
`204`		`- if (isset($params[0]) && null !== ($type = $params[0]->getType()) && self::class === $type->getName() && (!isset($params[1]) \|\| (null !== ($type = $params[1]->getType()) && Options::class === $type->getName()))) {`
	`204`	`+ if (isset($params[0]) && null !== ($type = $params[0]->getType()) && self::class === $type->getName() && (!isset($params[1]) \|\| (($type = $params[1]->getType()) instanceof \ReflectionNamedType && Options::class === $type->getName()))) {`
`205`	`205`	`// Store closure for later evaluation`
`206`	`206`	`$this->nested[$option][] = $value;`
`207`	`207`	`$this->defaults[$option] = [];`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public function getProvidedServices(): array`
`87`	`87`	`} else {`
`88`	`88`	`$type = (new \ReflectionFunction($factory))->getReturnType();`
`89`	`89`
`90`		`- $this->providedTypes[$name] = $type ? ($type->allowsNull() ? '?' : '').$type->getName() : '?';`
	`90`	`+ $this->providedTypes[$name] = $type ? ($type->allowsNull() ? '?' : '').($type instanceof \ReflectionNamedType ? $type->getName() : $type) : '?';`
`91`	`91`	`}`
`92`	`92`	`}`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public static function getSubscribedServices(): array`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`if (self::class === $method->getDeclaringClass()->name && ($returnType = $method->getReturnType()) && !$returnType->isBuiltin()) {`
`43`		`- $services[self::class.'::'.$method->name] = '?'.$returnType->getName();`
	`43`	`+ $services[self::class.'::'.$method->name] = '?'.($returnType instanceof \ReflectionNamedType ? $returnType->getName() : $type);`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`