Skip to content

Commit 70f8452

Browse files
ondrejmirtesondrejmirtes
committed
Infer correct type for $input->getOptions() call
1 parent f4cb3b8 commit 70f8452

File tree

6 files changed

+123
-19
lines changed

6 files changed

+123
-19
lines changed

‎extension.neon‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,17 @@ services:
175175
tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
176176

177177
# InputInterface::getOption() return type
178+
-
179+
factory: PHPStan\Type\Symfony\GetOptionTypeHelper
178180
-
179181
factory: PHPStan\Type\Symfony\InputInterfaceGetOptionDynamicReturnTypeExtension
180182
tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
181183

184+
# InputInterface::getOptions() return type
185+
-
186+
factory: PHPStan\Type\Symfony\InputInterfaceGetOptionsDynamicReturnTypeExtension
187+
tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
188+
182189
# InputInterface::hasOption() type specification
183190
-
184191
factory: PHPStan\Type\Symfony\OptionTypeSpecifyingExtension

‎src/Type/Symfony/GetOptionTypeHelper.php‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\Symfony;
4+
5+
use PHPStan\Analyser\Scope;
6+
use PHPStan\Type\ArrayType;
7+
use PHPStan\Type\BooleanType;
8+
use PHPStan\Type\IntegerType;
9+
use PHPStan\Type\NullType;
10+
use PHPStan\Type\StringType;
11+
use PHPStan\Type\Type;
12+
use PHPStan\Type\TypeCombinator;
13+
use Symfony\Component\Console\Input\InputOption;
14+
15+
class GetOptionTypeHelper
16+
{
17+
18+
public function getOptionType(Scope $scope, InputOption $option): Type
19+
{
20+
if (!$option->acceptValue()) {
21+
return new BooleanType();
22+
}
23+
24+
$optType = TypeCombinator::union(new StringType(), new NullType());
25+
if ($option->isValueRequired() && ($option->isArray() || $option->getDefault() !== null)) {
26+
$optType = TypeCombinator::removeNull($optType);
27+
}
28+
if ($option->isArray()) {
29+
$optType = new ArrayType(new IntegerType(), $optType);
30+
}
31+
32+
return TypeCombinator::union($optType, $scope->getTypeFromValue($option->getDefault()));
33+
}
34+
35+
}

‎src/Type/Symfony/InputInterfaceGetOptionDynamicReturnTypeExtension.php‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,7 @@
88
use PHPStan\Reflection\MethodReflection;
99
use PHPStan\Reflection\ParametersAcceptorSelector;
1010
use PHPStan\Symfony\ConsoleApplicationResolver;
11-
use PHPStan\Type\ArrayType;
12-
use PHPStan\Type\BooleanType;
1311
use PHPStan\Type\DynamicMethodReturnTypeExtension;
14-
use PHPStan\Type\IntegerType;
15-
use PHPStan\Type\NullType;
16-
use PHPStan\Type\StringType;
1712
use PHPStan\Type\Type;
1813
use PHPStan\Type\TypeCombinator;
1914
use PHPStan\Type\TypeUtils;
@@ -25,9 +20,13 @@ final class InputInterfaceGetOptionDynamicReturnTypeExtension implements Dynamic
2520
/** @var ConsoleApplicationResolver */
2621
private $consoleApplicationResolver;
2722

28-
public function __construct(ConsoleApplicationResolver $consoleApplicationResolver)
23+
/** @var GetOptionTypeHelper */
24+
private $getOptionTypeHelper;
25+
26+
public function __construct(ConsoleApplicationResolver $consoleApplicationResolver, GetOptionTypeHelper $getOptionTypeHelper)
2927
{
3028
$this->consoleApplicationResolver = $consoleApplicationResolver;
29+
$this->getOptionTypeHelper = $getOptionTypeHelper;
3130
}
3231

3332
public function getClass(): string
@@ -64,19 +63,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
6463
try {
6564
$command->mergeApplicationDefinition();
6665
$option = $command->getDefinition()->getOption($optName);
67-
if (!$option->acceptValue()) {
68-
$optType = new BooleanType();
69-
} else {
70-
$optType = TypeCombinator::union(new StringType(), new NullType());
71-
if ($option->isValueRequired() && ($option->isArray() || $option->getDefault() !== null)) {
72-
$optType = TypeCombinator::removeNull($optType);
73-
}
74-
if ($option->isArray()) {
75-
$optType = new ArrayType(new IntegerType(), $optType);
76-
}
77-
$optType = TypeCombinator::union($optType, $scope->getTypeFromValue($option->getDefault()));
78-
}
79-
$optTypes[] = $optType;
66+
$optTypes[] = $this->getOptionTypeHelper->getOptionType($scope, $option);
8067
} catch (InvalidArgumentException $e) {
8168
// noop
8269
}

‎src/Type/Symfony/InputInterfaceGetOptionsDynamicReturnTypeExtension.php‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\Symfony;
4+
5+
use InvalidArgumentException;
6+
use PhpParser\Node\Expr\MethodCall;
7+
use PHPStan\Analyser\Scope;
8+
use PHPStan\Reflection\MethodReflection;
9+
use PHPStan\Reflection\ParametersAcceptorSelector;
10+
use PHPStan\Symfony\ConsoleApplicationResolver;
11+
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
12+
use PHPStan\Type\Constant\ConstantStringType;
13+
use PHPStan\Type\DynamicMethodReturnTypeExtension;
14+
use PHPStan\Type\Type;
15+
use PHPStan\Type\TypeCombinator;
16+
use function count;
17+
18+
final class InputInterfaceGetOptionsDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
19+
{
20+
21+
/** @var ConsoleApplicationResolver */
22+
private $consoleApplicationResolver;
23+
24+
/** @var GetOptionTypeHelper */
25+
private $getOptionTypeHelper;
26+
27+
public function __construct(ConsoleApplicationResolver $consoleApplicationResolver, GetOptionTypeHelper $getOptionTypeHelper)
28+
{
29+
$this->consoleApplicationResolver = $consoleApplicationResolver;
30+
$this->getOptionTypeHelper = $getOptionTypeHelper;
31+
}
32+
33+
public function getClass(): string
34+
{
35+
return 'Symfony\Component\Console\Input\InputInterface';
36+
}
37+
38+
public function isMethodSupported(MethodReflection $methodReflection): bool
39+
{
40+
return $methodReflection->getName() === 'getOptions';
41+
}
42+
43+
public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
44+
{
45+
$defaultReturnType = ParametersAcceptorSelector::selectFromArgs($scope, $methodCall->getArgs(), $methodReflection->getVariants())->getReturnType();
46+
$classReflection = $scope->getClassReflection();
47+
if ($classReflection === null) {
48+
return $defaultReturnType;
49+
}
50+
51+
$optTypes = [];
52+
foreach ($this->consoleApplicationResolver->findCommands($classReflection) as $command) {
53+
try {
54+
$command->mergeApplicationDefinition();
55+
$options = $command->getDefinition()->getOptions();
56+
$builder = ConstantArrayTypeBuilder::createEmpty();
57+
foreach ($options as $name => $option) {
58+
$optionType = $this->getOptionTypeHelper->getOptionType($scope, $option);
59+
$builder->setOffsetValueType(new ConstantStringType($name), $optionType);
60+
}
61+
62+
$optTypes[] = $builder->getArray();
63+
} catch (InvalidArgumentException $e) {
64+
// noop
65+
}
66+
}
67+
68+
return count($optTypes) > 0 ? TypeCombinator::union(...$optTypes) : $defaultReturnType;
69+
}
70+
71+
}

‎tests/Type/Symfony/data/ExampleOptionCommand.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
4040
assertType('1|string', $input->getOption('cc'));
4141
assertType('array<int, 1|string|null>', $input->getOption('dd'));
4242
assertType('array<int, 1|string>', $input->getOption('ee'));
43+
44+
assertType('array{a: bool, b: string|null, c: string|null, d: array<int, string|null>, e: array<int, string>, bb: 1|string|null, cc: 1|string, dd: array<int, 1|string|null>, ee: array<int, 1|string>, help: bool, quiet: bool, verbose: bool, version: bool, ansi: bool, no-interaction: bool}', $input->getOptions());
4345
}
4446

4547
}

‎tests/Type/Symfony/data/ExampleOptionLazyCommand.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
4242
assertType('1|string', $input->getOption('cc'));
4343
assertType('array<int, 1|string|null>', $input->getOption('dd'));
4444
assertType('array<int, 1|string>', $input->getOption('ee'));
45+
46+
assertType('array{a: bool, b: string|null, c: string|null, d: array<int, string|null>, e: array<int, string>, bb: 1|string|null, cc: 1|string, dd: array<int, 1|string|null>, ee: array<int, 1|string>, help: bool, quiet: bool, verbose: bool, version: bool, ansi: bool, no-interaction: bool}', $input->getOptions());
4547
}
4648

4749
}

0 commit comments

Comments
 (0)