forked from phpstan/phpstan-src
-
Notifications
You must be signed in to change notification settings - Fork 0
/
UnusedFunctionParametersCheck.php
106 lines (95 loc) · 2.83 KB
/
UnusedFunctionParametersCheck.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
95
96
97
98
99
100
101
102
103
104
105
106
<?php declare(strict_types = 1);
namespace PHPStan\Rules;
use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\Constant\ConstantStringType;
use function array_fill_keys;
use function array_keys;
use function array_merge;
use function is_array;
use function is_string;
use function sprintf;
class UnusedFunctionParametersCheck
{
public function __construct(private ReflectionProvider $reflectionProvider)
{
}
/**
* @param string[] $parameterNames
* @param Node[] $statements
* @param mixed[] $additionalMetadata
* @return RuleError[]
*/
public function getUnusedParameters(
Scope $scope,
array $parameterNames,
array $statements,
string $unusedParameterMessage,
string $identifier,
array $additionalMetadata,
): array
{
$unusedParameters = array_fill_keys($parameterNames, true);
foreach ($this->getUsedVariables($scope, $statements) as $variableName) {
if (!isset($unusedParameters[$variableName])) {
continue;
}
unset($unusedParameters[$variableName]);
}
$errors = [];
foreach (array_keys($unusedParameters) as $name) {
$errors[] = RuleErrorBuilder::message(
sprintf($unusedParameterMessage, $name),
)->identifier($identifier)->metadata($additionalMetadata + ['variableName' => $name])->build();
}
return $errors;
}
/**
* @param Node[]|Node|scalar|null $node
* @return string[]
*/
private function getUsedVariables(Scope $scope, $node): array
{
$variableNames = [];
if ($node instanceof Node) {
if ($node instanceof Node\Expr\FuncCall && $node->name instanceof Node\Name) {
$functionName = $this->reflectionProvider->resolveFunctionName($node->name, $scope);
if ($functionName === 'func_get_args') {
return $scope->getDefinedVariables();
}
}
if ($node instanceof Node\Expr\Variable && is_string($node->name) && $node->name !== 'this') {
return [$node->name];
}
if ($node instanceof Node\Expr\ClosureUse && is_string($node->var->name)) {
return [$node->var->name];
}
if (
$node instanceof Node\Expr\FuncCall
&& $node->name instanceof Node\Name
&& (string) $node->name === 'compact'
) {
foreach ($node->getArgs() as $arg) {
$argType = $scope->getType($arg->value);
if (!($argType instanceof ConstantStringType)) {
continue;
}
$variableNames[] = $argType->getValue();
}
}
foreach ($node->getSubNodeNames() as $subNodeName) {
if ($node instanceof Node\Expr\Closure && $subNodeName !== 'uses') {
continue;
}
$subNode = $node->{$subNodeName};
$variableNames = array_merge($variableNames, $this->getUsedVariables($scope, $subNode));
}
} elseif (is_array($node)) {
foreach ($node as $subNode) {
$variableNames = array_merge($variableNames, $this->getUsedVariables($scope, $subNode));
}
}
return $variableNames;
}
}