1: <?php declare(strict_types = 1);
2:
3: namespace PHPStan\Rules\RestrictedUsage;
4:
5: use PhpParser\Node;
6: use PhpParser\Node\Name;
7: use PHPStan\Analyser\Scope;
8: use PHPStan\DependencyInjection\AutowiredExtensions;
9: use PHPStan\DependencyInjection\AutowiredService;
10: use PHPStan\DependencyInjection\ExtensionsCollection;
11: use PHPStan\Reflection\ReflectionProvider;
12: use PHPStan\Rules\Rule;
13: use PHPStan\Rules\RuleErrorBuilder;
14:
15: /**
16: * @implements Rule<Node\Expr\FuncCall>
17: */
18: #[AutowiredService]
19: final class RestrictedFunctionUsageRule implements Rule
20: {
21:
22: /**
23: * @param ExtensionsCollection<RestrictedFunctionUsageExtension> $extensions
24: */
25: public function __construct(
26: #[AutowiredExtensions(of: RestrictedFunctionUsageExtension::class)]
27: private ExtensionsCollection $extensions,
28: private ReflectionProvider $reflectionProvider,
29: )
30: {
31: }
32:
33: public function getNodeType(): string
34: {
35: return Node\Expr\FuncCall::class;
36: }
37:
38: /**
39: * @api
40: */
41: public function processNode(Node $node, Scope $scope): array
42: {
43: if (!($node->name instanceof Name)) {
44: return [];
45: }
46:
47: if (!$this->reflectionProvider->hasFunction($node->name, $scope)) {
48: return [];
49: }
50:
51: $functionReflection = $this->reflectionProvider->getFunction($node->name, $scope);
52:
53: $extensions = $this->extensions->getAll();
54: $errors = [];
55:
56: foreach ($extensions as $extension) {
57: $restrictedUsage = $extension->isRestrictedFunctionUsage($functionReflection, $scope);
58: if ($restrictedUsage === null) {
59: continue;
60: }
61:
62: $errors[] = RuleErrorBuilder::message($restrictedUsage->errorMessage)
63: ->identifier($restrictedUsage->identifier)
64: ->build();
65: }
66:
67: return $errors;
68: }
69:
70: }
71: