phpstan fix

Author: Bartłomiej Nowak

src/Symfony/Message.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Symfony;
 
+use PHPStan\Type\Type;
 use function count;
 
 final class Message
@@ -10,9 +11,10 @@ final class Message
 	/** @var string */
 	private $class;
 
-	/** @var array */
+	/** @var Type[] */
 	private $returnTypes;
 
+	/** @param Type[] $returnTypes */
 	public function __construct(string $class, array $returnTypes)
 	{
 		$this->class = $class;
@@ -24,6 +26,7 @@ public function getClass(): string
 		return $this->class;
 	}
 
+	/** @return Type[] */
 	public function getReturnTypes(): array
 	{
 		return $this->returnTypes;

src/Symfony/MessageMap.php

@@ -2,8 +2,6 @@
 
 namespace PHPStan\Symfony;
 
-use function array_key_exists;
-
 final class MessageMap
 {
 
@@ -25,9 +23,4 @@ public function getMessageForClass(string $class): ?Message
 		return $this->messages[$class] ?? null;
 	}
 
-	public function hasMessageForClass(string $class): bool
-	{
-		return array_key_exists($class, $this->messages);
-	}
-
 }

src/Symfony/MessageMapFactory.php

@@ -5,8 +5,6 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Reflection\ReflectionProvider;
-use PHPStan\Type\ObjectType;
-use PHPStan\Type\UnionType;
 use RuntimeException;
 use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
 use function count;
@@ -18,6 +16,8 @@
 final class MessageMapFactory
 {
 
+	private const DEFAULT_HANDLER_METHOD = '__invoke';
+
 	/** @var ReflectionProvider */
 	private $reflectionProvider;
 
@@ -53,19 +53,13 @@ public function create(): MessageMap
 				$reflectionClass = $this->reflectionProvider->getClass($serviceClass);
 
 				if (isset($tagAttributes['handles'])) {
-					$handles = isset($tag['method']) ? [$tag['handles'] => $tag['method']] : [$tag['handles']];
+					// todo cover by test case
+					$handles = [$tagAttributes['handles'] => ['method' => $tagAttributes['method'] ?? self::DEFAULT_HANDLER_METHOD]];
 				} else {
 					$handles = $this->guessHandledMessages($reflectionClass);
 				}
 
 				foreach ($handles as $messageClassName => $options) {
-					if (is_int($messageClassName) && is_string($options)) {
-						$messageClassName = $options;
-						$options = [];
-					}
-
-					$options['method'] = $options['method'] ?? '__invoke';
-
 					$methodReflection = $reflectionClass->getNativeMethod($options['method']);
 					$variant = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants());
 
@@ -82,15 +76,24 @@ public function create(): MessageMap
 		return new MessageMap($messages);
 	}
 
+	/** @return array<string, array<string, string>> */
 	private function guessHandledMessages(ClassReflection $reflectionClass): iterable
 	{
 		if ($reflectionClass->implementsInterface(MessageSubscriberInterface::class)) {
 			// todo handle different return formats
-			return $reflectionClass->getName()::getHandledMessages();
+			foreach ($reflectionClass->getName()::getHandledMessages() as $index => $value) {
+				if (is_int($index) && is_string($value)) {
+					yield $value => ['method' => self::DEFAULT_HANDLER_METHOD];
+				} else {
+					yield $index => $value;
+				}
+			}
+
+			return;
 		}
 
 		// todo handle if doesn't exists
-		$methodReflection = $reflectionClass->getNativeMethod('__invoke');
+		$methodReflection = $reflectionClass->getNativeMethod(self::DEFAULT_HANDLER_METHOD);
 
 		$variant = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants());
 		$parameters = $variant->getParameters();
@@ -102,30 +105,10 @@ private function guessHandledMessages(ClassReflection $reflectionClass): iterabl
 
 		$type = $parameters[0]->getType();
 
-		if ($type instanceof UnionType) {
-			$types = [];
-			foreach ($type->getTypes() as $type) {
-				if (!$type instanceof ObjectType) {
-					// todo handle error
-					throw new RuntimeException('invalid handler');
-				}
-
-				$types[] = $type->getClassName();
-			}
-
-			if ($types) {
-				return $types;
-			}
-
-			// todo handle error
-			throw new RuntimeException('invalid handler');
+		// todo many class names?
+		foreach ($type->getObjectClassNames() as $className) {
+			yield $className => ['method' => self::DEFAULT_HANDLER_METHOD];
 		}
-
-		if (!$type instanceof ObjectType) {
-			throw new RuntimeException('invalid handler');
-		}
-
-		return [$type->getClassName()];
 	}
 
 }

src/Symfony/Service.php

@@ -20,9 +20,10 @@ final class Service implements ServiceDefinition
 	/** @var string|null */
 	private $alias;
 
-	/** @var array */
+	/** @var ServiceTag[] */
 	private $tags;
 
+	/** @param ServiceTag[] $tags */
 	public function __construct(
 		string $id,
 		?string $class,

src/Symfony/ServiceDefinition.php

@@ -15,6 +15,7 @@ public function isSynthetic(): bool;
 
 	public function getAlias(): ?string;
 
+	/** @return ServiceTag[] */
 	public function getTags(): array;
 
 }

src/Symfony/ServiceTag.php

@@ -8,9 +8,10 @@ final class ServiceTag implements ServiceTagDefinition
 	/** @var string */
 	private $name;
 
-	/** @var array */
+	/** @var array<string, string> */
 	private $attributes;
 
+	/** @param array<string, string> $attributes */
 	public function __construct(string $name, array $attributes = [])
 	{
 		$this->name = $name;

src/Symfony/ServiceTagDefinition.php

@@ -7,6 +7,7 @@ interface ServiceTagDefinition
 
 	public function getName(): string;
 
+	/** @return array<string, string> */
 	public function getAttributes(): array;
 
 }

src/Type/Symfony/MessengerHandleTraitDynamicReturnTypeExtension.php

@@ -9,16 +9,17 @@
 use PHPStan\Symfony\MessageMap;
 use PHPStan\Symfony\MessageMapFactory;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
-use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
+use function count;
+use function is_null;
 
 final class MessengerHandleTraitDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
 {
 
 	/** @var MessageMapFactory */
 	private $messageMapFactory;
 
-	/** @var MessageMap */
+	/** @var MessageMap|null */
 	private $messageMap;
 
 	public function __construct(MessageMapFactory $symfonyMessageMapFactory)
@@ -34,8 +35,7 @@ public function getClass(): string
 		// todo or make it configurable with passing concrete classes names to extension config
 		// todo or use reflection somehow to get all classes that use HandleTrait and configure it dynamically
 
-		// todo temporarily hardcoded test class here
-		return HandleTraitClass::class;
+		return HandleTraitClass::class; // @phpstan-ignore-line todo temporarily hardcoded test class here
 	}
 
 	public function isMethodSupported(MethodReflection $methodReflection): bool
@@ -56,16 +56,15 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
 		//  - [] read SF doc to determine any other cases to covers
 
 		$arg = $methodCall->getArgs()[0]->value;
-		$argType = $scope->getType($arg);
+		$argClassNames = $scope->getType($arg)->getObjectClassNames();
 
-		if ($argType instanceof ObjectType) {
+		// todo filter out not handled cases on map creation?
+		if (count($argClassNames) === 1) {
 			$messageMap = $this->getMessageMap();
-			if ($messageMap->hasMessageForClass($argType->getClassName())) {
-				$message = $messageMap->getMessageForClass($argType->getClassName());
+			$message = $messageMap->getMessageForClass($argClassNames[0]);
 
-				if ($message->countReturnTypes() === 1) {
-					return $message->getReturnTypes()[0];
-				}
+			if (!is_null($message) && $message->countReturnTypes() === 1) {
+				return $message->getReturnTypes()[0];
 			}
 		}
 
@@ -74,7 +73,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
 
 	private function getMessageMap(): MessageMap
 	{
-		if (!$this->messageMap) {
+		if (is_null($this->messageMap)) {
 			$this->messageMap = $this->messageMapFactory->create();
 		}