Support for InputInterface::hasArgument and ::hasOption

Author: lookyman

README.md

@@ -15,7 +15,7 @@ This extension provides following features:
 * Provides correct return type for `Envelope::all()` method based on the `$stampFqcn` parameter.
 * Notifies you when you try to get an unregistered service from the container.
 * Notifies you when you try to get a private service from the container.
-* Optionally correct return types for `InputInterface::getArgument()` and `::getOption`
+* Optionally correct return types for `InputInterface::getArgument()`, `::getOption`, `::hasArgument`, and `::hasOption`.
 
 ## Usage
 

extension.neon

@@ -76,6 +76,11 @@ services:
 		factory: PHPStan\Type\Symfony\ArgumentTypeSpecifyingExtension
 		tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
 
+	# InputInterface::hasArgument() return type
+	-
+		factory: PHPStan\Type\Symfony\InputInterfaceHasArgumentDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+
 	# InputInterface::getOption() return type
 	-
 		factory: PHPStan\Type\Symfony\InputInterfaceGetOptionDynamicReturnTypeExtension
@@ -85,3 +90,8 @@ services:
 	-
 		factory: PHPStan\Type\Symfony\OptionTypeSpecifyingExtension
 		tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
+
+	# InputInterface::hasOption() return type
+	-
+		factory: PHPStan\Type\Symfony\InputInterfaceHasOptionDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]

src/Type/Symfony/InputInterfaceHasArgumentDynamicReturnTypeExtension.php

@@ -0,0 +1,77 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use InvalidArgumentException;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Symfony\ConsoleApplicationResolver;
+use PHPStan\Type\BooleanType;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeUtils;
+use function array_unique;
+use function count;
+
+final class InputInterfaceHasArgumentDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/** @var \PHPStan\Symfony\ConsoleApplicationResolver */
+	private $consoleApplicationResolver;
+
+	public function __construct(ConsoleApplicationResolver $consoleApplicationResolver)
+	{
+		$this->consoleApplicationResolver = $consoleApplicationResolver;
+	}
+
+	public function getClass(): string
+	{
+		return 'Symfony\Component\Console\Input\InputInterface';
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'hasArgument';
+	}
+
+	public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+	{
+		$defaultReturnType = new BooleanType();
+
+		if (!isset($methodCall->args[0])) {
+			return $defaultReturnType;
+		}
+
+		$classReflection = $scope->getClassReflection();
+		if ($classReflection === null) {
+			throw new ShouldNotHappenException();
+		}
+
+		$argStrings = TypeUtils::getConstantStrings($scope->getType($methodCall->args[0]->value));
+		if (count($argStrings) !== 1) {
+			return $defaultReturnType;
+		}
+		$argName = $argStrings[0]->getValue();
+
+		$returnTypes = [];
+		foreach ($this->consoleApplicationResolver->findCommands($classReflection) as $command) {
+			try {
+				$command->getDefinition()->getArgument($argName);
+				$returnTypes[] = true;
+			} catch (InvalidArgumentException $e) {
+				$returnTypes[] = false;
+			}
+		}
+
+		if (count($returnTypes) === 0) {
+			return $defaultReturnType;
+		}
+
+		$returnTypes = array_unique($returnTypes);
+		return count($returnTypes) === 1 ? new ConstantBooleanType($returnTypes[0]) : $defaultReturnType;
+	}
+
+}

src/Type/Symfony/InputInterfaceHasOptionDynamicReturnTypeExtension.php

@@ -0,0 +1,77 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use InvalidArgumentException;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Symfony\ConsoleApplicationResolver;
+use PHPStan\Type\BooleanType;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeUtils;
+use function array_unique;
+use function count;
+
+final class InputInterfaceHasOptionDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/** @var \PHPStan\Symfony\ConsoleApplicationResolver */
+	private $consoleApplicationResolver;
+
+	public function __construct(ConsoleApplicationResolver $consoleApplicationResolver)
+	{
+		$this->consoleApplicationResolver = $consoleApplicationResolver;
+	}
+
+	public function getClass(): string
+	{
+		return 'Symfony\Component\Console\Input\InputInterface';
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'hasOption';
+	}
+
+	public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+	{
+		$defaultReturnType = new BooleanType();
+
+		if (!isset($methodCall->args[0])) {
+			return $defaultReturnType;
+		}
+
+		$classReflection = $scope->getClassReflection();
+		if ($classReflection === null) {
+			throw new ShouldNotHappenException();
+		}
+
+		$optStrings = TypeUtils::getConstantStrings($scope->getType($methodCall->args[0]->value));
+		if (count($optStrings) !== 1) {
+			return $defaultReturnType;
+		}
+		$optName = $optStrings[0]->getValue();
+
+		$returnTypes = [];
+		foreach ($this->consoleApplicationResolver->findCommands($classReflection) as $command) {
+			try {
+				$command->getDefinition()->getOption($optName);
+				$returnTypes[] = true;
+			} catch (InvalidArgumentException $e) {
+				$returnTypes[] = false;
+			}
+		}
+
+		if (count($returnTypes) === 0) {
+			return $defaultReturnType;
+		}
+
+		$returnTypes = array_unique($returnTypes);
+		return count($returnTypes) === 1 ? new ConstantBooleanType($returnTypes[0]) : $defaultReturnType;
+	}
+
+}

tests/Symfony/NeonTest.php

@@ -41,7 +41,7 @@ public function testExtensionNeon(): void
 		], $container->getParameters());
 
 		self::assertCount(6, $container->findByTag('phpstan.rules.rule'));
-		self::assertCount(9, $container->findByTag('phpstan.broker.dynamicMethodReturnTypeExtension'));
+		self::assertCount(11, $container->findByTag('phpstan.broker.dynamicMethodReturnTypeExtension'));
 		self::assertCount(5, $container->findByTag('phpstan.typeSpecifier.methodTypeSpecifyingExtension'));
 		self::assertInstanceOf(ServiceMap::class, $container->getByType(ServiceMap::class));
 	}