Command::getHelper return type

Author: lookyman

Diff for: extension.neon

@@ -12,6 +12,8 @@ parameters:
 		- stubs/Symfony/Bundle/FrameworkBundle/KernelBrowser.stub
 		- stubs/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.stub
 		- stubs/Symfony/Bundle/FrameworkBundle/Test/TestContainer.stub
+		- stubs/Symfony/Component/Console/Command.stub
+		- stubs/Symfony/Component/Console/Helper/HelperInterface.stub
 		- stubs/Symfony/Component/Form/ChoiceList/Loader/ChoiceLoaderInterface.stub
 		- stubs/Symfony/Component/DependencyInjection/ContainerBuilder.stub
 		- stubs/Symfony/Component/DependencyInjection/Extension/ExtensionInterface.stub
@@ -255,3 +257,8 @@ services:
 	-
 		factory: PHPStan\Type\Symfony\Form\FormInterfaceDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+
+	# Command::getHelper() return type
+	-
+		factory: PHPStan\Type\Symfony\CommandGetHelperDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]

Diff for: src/Type/Symfony/CommandGetHelperDynamicReturnTypeExtension.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Symfony\ConsoleApplicationResolver;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\TypeUtils;
+use Throwable;
+use function count;
+use function get_class;
+
+final class CommandGetHelperDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/** @var \PHPStan\Symfony\ConsoleApplicationResolver */
+	private $consoleApplicationResolver;
+
+	public function __construct(ConsoleApplicationResolver $consoleApplicationResolver)
+	{
+		$this->consoleApplicationResolver = $consoleApplicationResolver;
+	}
+
+	public function getClass(): string
+	{
+		return 'Symfony\Component\Console\Command\Command';
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'getHelper';
+	}
+
+	public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+	{
+		$defaultReturnType = new ObjectType('Symfony\Component\Console\Helper\HelperInterface');
+
+		if (!isset($methodCall->getArgs()[0])) {
+			return $defaultReturnType;
+		}
+
+		$classReflection = $scope->getClassReflection();
+		if ($classReflection === null) {
+			return $defaultReturnType;
+		}
+
+		$argStrings = TypeUtils::getConstantStrings($scope->getType($methodCall->getArgs()[0]->value));
+		if (count($argStrings) !== 1) {
+			return $defaultReturnType;
+		}
+		$argName = $argStrings[0]->getValue();
+
+		$returnTypes = [];
+		foreach ($this->consoleApplicationResolver->findCommands($classReflection) as $command) {
+			try {
+				$command->mergeApplicationDefinition();
+				$returnTypes[] = new ObjectType(get_class($command->getHelper($argName)));
+			} catch (Throwable $e) {
+				// no-op
+			}
+		}
+
+		return count($returnTypes) > 0 ? TypeCombinator::union(...$returnTypes) : $defaultReturnType;
+	}
+
+}

Diff for: stubs/Symfony/Component/Console/Command.stub

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\Console\Command;
+
+class Command
+{
+    /**
+     * @return \Symfony\Component\Console\Helper\HelperInterface
+     */
+    public function getHelper(string $name);
+}

Diff for: stubs/Symfony/Component/Console/Helper/HelperInterface.stub

@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\Console\Helper;
+
+interface HelperInterface
+{
+}

Diff for: tests/Type/Symfony/data/ExampleBaseCommand.php

@@ -25,6 +25,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		assertType('array<int, string>|string', $input->getArgument('diff'));
 		assertType('array<int, string>', $input->getArgument('arr'));
 		assertType('string|null', $input->getArgument('both'));
+		assertType('Symfony\Component\Console\Helper\QuestionHelper', $this->getHelper('question'));
 	}
 
 }