MissingCheckedExceptionInPropertyHookThrowsRule

Author: ondrejmirtes

conf/config.neon

@@ -209,6 +209,8 @@ conditionalTags:
 		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
 	PHPStan\Rules\Exceptions\MissingCheckedExceptionInMethodThrowsRule:
 		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
+	PHPStan\Rules\Exceptions\MissingCheckedExceptionInPropertyHookThrowsRule:
+		phpstan.rules.rule: %exceptions.check.missingCheckedExceptionInThrows%
 
 services:
 	-
@@ -906,6 +908,9 @@ services:
 	-
 		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInMethodThrowsRule
 
+	-
+		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInPropertyHookThrowsRule
+
 	-
 		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInThrowsCheck
 		arguments:

src/Rules/Exceptions/MissingCheckedExceptionInPropertyHookThrowsRule.php

@@ -0,0 +1,55 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Exceptions;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\PropertyHookReturnStatementsNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\ShouldNotHappenException;
+use function sprintf;
+use function ucfirst;
+
+/**
+ * @implements Rule<PropertyHookReturnStatementsNode>
+ */
+final class MissingCheckedExceptionInPropertyHookThrowsRule implements Rule
+{
+
+	public function __construct(private MissingCheckedExceptionInThrowsCheck $check)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return PropertyHookReturnStatementsNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$statementResult = $node->getStatementResult();
+		$hookReflection = $node->getHookReflection();
+
+		if (!$hookReflection->isPropertyHook()) {
+			throw new ShouldNotHappenException();
+		}
+
+		$errors = [];
+		foreach ($this->check->check($hookReflection->getThrowType(), $statementResult->getThrowPoints()) as [$className, $throwPointNode]) {
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'%s hook for property %s::$%s throws checked exception %s but it\'s missing from the PHPDoc @throws tag.',
+				ucfirst($hookReflection->getPropertyHookName()),
+				$hookReflection->getDeclaringClass()->getDisplayName(),
+				$hookReflection->getHookedPropertyName(),
+				$className,
+			))
+				->line($throwPointNode->getStartLine())
+				->identifier('missingType.checkedException')
+				->build();
+		}
+
+		return $errors;
+	}
+
+}

tests/PHPStan/Rules/Exceptions/MissingCheckedExceptionInPropertyHookThrowsRuleTest.php

@@ -0,0 +1,51 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Exceptions;
+
+use PHPStan\Rules\Rule;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<MissingCheckedExceptionInPropertyHookThrowsRule>
+ */
+class MissingCheckedExceptionInPropertyHookThrowsRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new MissingCheckedExceptionInPropertyHookThrowsRule(
+			new MissingCheckedExceptionInThrowsCheck(new DefaultExceptionTypeResolver(
+				$this->createReflectionProvider(),
+				[],
+				[ShouldNotHappenException::class],
+				[],
+				[],
+			)),
+		);
+	}
+
+	public function testRule(): void
+	{
+		if (PHP_VERSION_ID < 80400) {
+			$this->markTestSkipped('Test requires PHP 8.4.');
+		}
+
+		$this->analyse([__DIR__ . '/data/missing-exception-property-hook-throws.php'], [
+			[
+				'Get hook for property MissingExceptionPropertyHookThrows\Foo::$k throws checked exception InvalidArgumentException but it\'s missing from the PHPDoc @throws tag.',
+				25,
+			],
+			[
+				'Set hook for property MissingExceptionPropertyHookThrows\Foo::$l throws checked exception InvalidArgumentException but it\'s missing from the PHPDoc @throws tag.',
+				32,
+			],
+			[
+				'Get hook for property MissingExceptionPropertyHookThrows\Foo::$m throws checked exception InvalidArgumentException but it\'s missing from the PHPDoc @throws tag.',
+				38,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Exceptions/data/missing-exception-property-hook-throws.php

@@ -0,0 +1,42 @@
+<?php // lint >= 8.4
+
+namespace MissingExceptionPropertyHookThrows;
+
+class Foo
+{
+
+	public int $i {
+		/** @throws \InvalidArgumentException */
+		get {
+			throw new \InvalidArgumentException(); // ok
+		}
+	}
+
+	public int $j {
+		/** @throws \LogicException */
+		set {
+			throw new \InvalidArgumentException(); // ok
+		}
+	}
+
+	public int $k {
+		/** @throws \RuntimeException */
+		get {
+			throw new \InvalidArgumentException(); // error
+		}
+	}
+
+	public int $l {
+		/** @throws \RuntimeException */
+		set {
+			throw new \InvalidArgumentException(); // error
+		}
+	}
+
+	public int $m {
+		get {
+			throw new \InvalidArgumentException(); // error
+		}
+	}
+
+}