ExistingClassesInPropertyHookTypehintsRule - level 0

Author: ondrejmirtes

conf/config.level0.neon

@@ -92,6 +92,7 @@ rules:
 	- PHPStan\Rules\Operators\InvalidIncDecOperationRule
 	- PHPStan\Rules\Properties\AccessPropertiesInAssignRule
 	- PHPStan\Rules\Properties\AccessStaticPropertiesInAssignRule
+	- PHPStan\Rules\Properties\ExistingClassesInPropertyHookTypehintsRule
 	- PHPStan\Rules\Properties\InvalidCallablePropertyTypeRule
 	- PHPStan\Rules\Properties\MissingReadOnlyPropertyAssignRule
 	- PHPStan\Rules\Properties\MissingReadOnlyByPhpDocPropertyAssignRule

src/Rules/FunctionDefinitionCheck.php

@@ -245,7 +245,7 @@ public function checkAnonymousFunction(
 	 */
 	public function checkClassMethod(
 		PhpMethodFromParserNodeReflection $methodReflection,
-		ClassMethod $methodNode,
+		ClassMethod|Node\PropertyHook $methodNode,
 		string $parameterMessage,
 		string $returnMessage,
 		string $unionTypesMessage,

src/Rules/Properties/ExistingClassesInPropertyHookTypehintsRule.php

@@ -0,0 +1,78 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Internal\SprintfHelper;
+use PHPStan\Node\InPropertyHookNode;
+use PHPStan\Rules\FunctionDefinitionCheck;
+use PHPStan\Rules\Rule;
+use PHPStan\ShouldNotHappenException;
+use function sprintf;
+use function ucfirst;
+
+/**
+ * @implements Rule<InPropertyHookNode>
+ */
+final class ExistingClassesInPropertyHookTypehintsRule implements Rule
+{
+
+	public function __construct(private FunctionDefinitionCheck $check)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return InPropertyHookNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$hookReflection = $node->getHookReflection();
+		if (!$hookReflection->isPropertyHook()) {
+			throw new ShouldNotHappenException();
+		}
+		$className = SprintfHelper::escapeFormatString($node->getClassReflection()->getDisplayName());
+		$hookName = $hookReflection->getPropertyHookName();
+		$propertyName = SprintfHelper::escapeFormatString($hookReflection->getHookedPropertyName());
+
+		return $this->check->checkClassMethod(
+			$hookReflection,
+			$node->getOriginalNode(),
+			sprintf(
+				'Parameter $%%s of %s hook for property %s::$%s has invalid type %%s.',
+				$hookName,
+				$className,
+				$propertyName,
+			),
+			sprintf(
+				'%s hook for property %s::$%s has invalid return type %%s.',
+				ucfirst($hookName),
+				$className,
+				$propertyName,
+			),
+			sprintf('%s hook for property %s::$%s uses native union types but they\'re supported only on PHP 8.0 and later.', $hookName, $className, $propertyName),
+			sprintf('Template type %%s of %s hook for property %s::$%s is not referenced in a parameter.', $hookName, $className, $propertyName),
+			sprintf(
+				'Parameter $%%s of %s hook for property %s::$%s has unresolvable native type.',
+				$hookName,
+				$className,
+				$propertyName,
+			),
+			sprintf(
+				'%s hook for property %s::$%s has unresolvable native return type.',
+				ucfirst($hookName),
+				$className,
+				$propertyName,
+			),
+			sprintf(
+				'%s hook for property %s::$%s has invalid @phpstan-self-out type %%s.',
+				ucfirst($hookName),
+				$className,
+				$propertyName,
+			),
+		);
+	}
+
+}

tests/PHPStan/Rules/Properties/ExistingClassesInPropertyHookTypehintsRuleTest.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\ClassCaseSensitivityCheck;
+use PHPStan\Rules\ClassForbiddenNameCheck;
+use PHPStan\Rules\ClassNameCheck;
+use PHPStan\Rules\FunctionDefinitionCheck;
+use PHPStan\Rules\PhpDoc\UnresolvableTypeHelper;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<ExistingClassesInPropertyHookTypehintsRule>
+ */
+class ExistingClassesInPropertyHookTypehintsRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+		return new ExistingClassesInPropertyHookTypehintsRule(
+			new FunctionDefinitionCheck(
+				$reflectionProvider,
+				new ClassNameCheck(
+					new ClassCaseSensitivityCheck($reflectionProvider, true),
+					new ClassForbiddenNameCheck(self::getContainer()),
+				),
+				new UnresolvableTypeHelper(),
+				new PhpVersion(PHP_VERSION_ID),
+				true,
+				false,
+			),
+		);
+	}
+
+	public function testRule(): void
+	{
+		if (PHP_VERSION_ID < 80400) {
+			$this->markTestSkipped('Test requires PHP 8.4.');
+		}
+
+		$this->analyse([__DIR__ . '/data/existing-classes-property-hooks.php'], [
+			[
+				'Parameter $v of set hook for property ExistingClassesPropertyHooks\Foo::$i has invalid type ExistingClassesPropertyHooks\Nonexistent.',
+				9,
+			],
+			[
+				'Parameter $v of set hook for property ExistingClassesPropertyHooks\Foo::$j has unresolvable native type.',
+				15,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Properties/data/existing-classes-property-hooks.php

@@ -0,0 +1,20 @@
+<?php // lint >= 8.4
+
+namespace ExistingClassesPropertyHooks;
+
+class Foo
+{
+
+	public int $i {
+		set (Nonexistent $v) {
+
+		}
+	}
+
+	public \stdClass $j {
+		set (\stdClass&\Exception $v) {
+
+		}
+	}
+
+}