DefineParametersRule for checking deprecated arg 3

Author: mglaman

conf/config.level0.neon

@@ -36,6 +36,7 @@ rules:
 	- PHPStan\Rules\Functions\ArrowFunctionReturnNullsafeByRefRule
 	- PHPStan\Rules\Functions\CallToFunctionParametersRule
 	- PHPStan\Rules\Functions\ClosureAttributesRule
+	- PHPStan\Rules\Functions\DefineParametersRule
 	- PHPStan\Rules\Functions\ExistingClassesInArrowFunctionTypehintsRule
 	- PHPStan\Rules\Functions\ExistingClassesInClosureTypehintsRule
 	- PHPStan\Rules\Functions\ExistingClassesInTypehintsRule

src/Rules/Functions/DefineParametersRule.php

@@ -0,0 +1,51 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Functions;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Php\PhpVersion;
+
+/**
+ * @implements \PHPStan\Rules\Rule<\PhpParser\Node\Expr\FuncCall>
+ */
+class DefineParametersRule implements \PHPStan\Rules\Rule
+{
+
+	private PhpVersion $phpVersion;
+
+	public function __construct(PhpVersion $phpVersion)
+	{
+		$this->phpVersion = $phpVersion;
+	}
+
+	public function getNodeType(): string
+	{
+		return FuncCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!($node->name instanceof \PhpParser\Node\Name)) {
+			return [];
+		}
+		if ($this->phpVersion->getVersionId() < 80000) {
+			return [];
+		}
+		$name = strtolower((string) $node->name);
+		if ($name !== 'define') {
+			return [];
+		}
+		$args = $node->getArgs();
+		$argsCount = count($args);
+		// Expects 2, 1 arg is caught by CallToFunctionParametersRule
+		if ($argsCount < 3) {
+			return [];
+		}
+		return [
+			'Argument #3 ($case_insensitive) is ignored since declaration of case-insensitive constants is no longer supported.',
+		];
+	}
+
+}

tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php

@@ -131,19 +131,6 @@ public function testCallToArrayUnique(): void
 		]);
 	}
 
-	public function testCallToDefineCaseInsenstive(): void
-	{
-		if (PHP_VERSION_ID < 80000) {
-			$this->markTestSkipped('Test requires PHP 8.0.');
-		}
-		$this->analyse([__DIR__ . '/data/call-to-define.php'], [
-			[
-				'Argument #3 ($case_insensitive) is ignored since declaration of case-insensitive constants is no longer supported',
-				3,
-			],
-		]);
-	}
-
 	public function testCallToArrayMapVariadic(): void
 	{
 		$this->analyse([__DIR__ . '/data/call-to-array-map-unique.php'], []);

tests/PHPStan/Rules/Functions/DefineParametersRuleTest.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Functions;
+
+use PHPStan\Php\PhpVersion;
+
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<DefineParametersRule>
+ */
+class DefineParametersRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function getRule(): \PHPStan\Rules\Rule
+	{
+		return new DefineParametersRule(new PhpVersion(PHP_VERSION_ID));
+	}
+
+	public function testFile(): void
+	{
+		if (PHP_VERSION_ID < 80000) {
+			$this->markTestSkipped('Test requires PHP 8.0.');
+		}
+		$this->analyse([__DIR__ . '/data/call-to-define.php'], [
+			[
+				'Argument #3 ($case_insensitive) is ignored since declaration of case-insensitive constants is no longer supported.',
+				3,
+			],
+		]);
+	}
+
+}