-
Notifications
You must be signed in to change notification settings - Fork 426
/
SprintfFunctionDynamicReturnTypeExtension.php
94 lines (79 loc) · 2.39 KB
/
SprintfFunctionDynamicReturnTypeExtension.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?php declare(strict_types = 1);
namespace PHPStan\Type\Php;
use PhpParser\Node\Expr\FuncCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
use PHPStan\Type\Accessory\AccessoryNumericStringType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\ConstantScalarType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
use PHPStan\Type\IntersectionType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use Throwable;
use function array_key_exists;
use function array_shift;
use function count;
use function is_string;
use function preg_match;
use function sprintf;
class SprintfFunctionDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
{
public function isFunctionSupported(FunctionReflection $functionReflection): bool
{
return $functionReflection->getName() === 'sprintf';
}
public function getTypeFromFunctionCall(
FunctionReflection $functionReflection,
FuncCall $functionCall,
Scope $scope,
): ?Type
{
$args = $functionCall->getArgs();
if (count($args) === 0) {
return ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
}
$formatType = $scope->getType($args[0]->value);
if ($formatType instanceof ConstantStringType) {
// The printf format is %[argnum$][flags][width][.precision]
if (preg_match('/^%([0-9]*\$)?[0-9]*\.?[0-9]+[bdeEfFgGhHouxX]$/', $formatType->getValue(), $matches) === 1) {
// invalid positional argument
if (array_key_exists(1, $matches) && $matches[1] === '0$') {
return null;
}
return new IntersectionType([
new StringType(),
new AccessoryNumericStringType(),
]);
}
}
if ($formatType->isNonEmptyString()->yes()) {
$returnType = new IntersectionType([
new StringType(),
new AccessoryNonEmptyStringType(),
]);
} else {
$returnType = new StringType();
}
$values = [];
foreach ($args as $arg) {
$argType = $scope->getType($arg->value);
if (!$argType instanceof ConstantScalarType) {
return $returnType;
}
$values[] = $argType->getValue();
}
$format = array_shift($values);
if (!is_string($format)) {
return $returnType;
}
try {
$value = @sprintf($format, ...$values);
} catch (Throwable) {
return $returnType;
}
return $scope->getTypeFromValue($value);
}
}