SetNonVirtualPropertyHookAssignRule - level 3

Author: ondrejmirtes

conf/config.level3.neon

@@ -20,6 +20,7 @@ rules:
 	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyAssignRefRule
 	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRefRule
+	- PHPStan\Rules\Properties\SetNonVirtualPropertyHookAssignRule
 	- PHPStan\Rules\Properties\ShortGetPropertyHookReturnTypeRule
 	- PHPStan\Rules\Properties\TypesAssignedToPropertiesRule
 	- PHPStan\Rules\Variables\ParameterOutAssignedTypeRule

src/Rules/Properties/SetNonVirtualPropertyHookAssignRule.php

@@ -0,0 +1,97 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\Expr\PropertyInitializationExpr;
+use PHPStan\Node\PropertyHookReturnStatementsNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\NeverType;
+use function sprintf;
+
+/**
+ * @implements Rule<PropertyHookReturnStatementsNode>
+ */
+final class SetNonVirtualPropertyHookAssignRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return PropertyHookReturnStatementsNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$hookNode = $node->getPropertyHookNode();
+		if ($hookNode->name->toLowerString() !== 'set') {
+			return [];
+		}
+
+		$hookReflection = $node->getHookReflection();
+		if (!$hookReflection->isPropertyHook()) {
+			throw new ShouldNotHappenException();
+		}
+
+		$propertyName = $hookReflection->getHookedPropertyName();
+		$classReflection = $node->getClassReflection();
+		if (!$classReflection->hasNativeProperty($propertyName)) {
+			throw new ShouldNotHappenException();
+		}
+
+		$propertyReflection = $classReflection->getNativeProperty($propertyName);
+		if ($propertyReflection->isVirtual()->yes()) {
+			return [];
+		}
+
+		$finalHookScope = null;
+		foreach ($node->getExecutionEnds() as $executionEnd) {
+			$statementResult = $executionEnd->getStatementResult();
+			$endNode = $executionEnd->getNode();
+			if ($statementResult->isAlwaysTerminating()) {
+				if ($endNode instanceof Node\Stmt\Expression) {
+					$exprType = $statementResult->getScope()->getType($endNode->expr);
+					if ($exprType instanceof NeverType && $exprType->isExplicit()) {
+						continue;
+					}
+				}
+			}
+			if ($finalHookScope === null) {
+				$finalHookScope = $statementResult->getScope();
+				continue;
+			}
+
+			$finalHookScope = $finalHookScope->mergeWith($statementResult->getScope());
+		}
+
+		foreach ($node->getReturnStatements() as $returnStatement) {
+			if ($finalHookScope === null) {
+				$finalHookScope = $returnStatement->getScope();
+				continue;
+			}
+			$finalHookScope = $finalHookScope->mergeWith($returnStatement->getScope());
+		}
+
+		if ($finalHookScope === null) {
+			return [];
+		}
+
+		$initExpr = new PropertyInitializationExpr($propertyName);
+		$hasInit = $finalHookScope->hasExpressionType($initExpr);
+		if ($hasInit->yes()) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message(sprintf(
+				'Set hook for non-virtual property %s::$%s does not %sassign value to it.',
+				$classReflection->getDisplayName(),
+				$propertyName,
+				$hasInit->maybe() ? 'always ' : '',
+			))->identifier('propertySetHook.noAssign')->build(),
+		];
+	}
+
+}

tests/PHPStan/Rules/Properties/SetNonVirtualPropertyHookAssignRuleTest.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<SetNonVirtualPropertyHookAssignRule>
+ */
+class SetNonVirtualPropertyHookAssignRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new SetNonVirtualPropertyHookAssignRule();
+	}
+
+	public function testRule(): void
+	{
+		if (PHP_VERSION_ID < 80400) {
+			$this->markTestSkipped('Test requires PHP 8.4.');
+		}
+
+		$this->analyse([__DIR__ . '/data/set-non-virtual-property-hook-assign.php'], [
+			[
+				'Set hook for non-virtual property SetNonVirtualPropertyHookAssign\Foo::$k does not assign value to it.',
+				24,
+			],
+			[
+				'Set hook for non-virtual property SetNonVirtualPropertyHookAssign\Foo::$k2 does not always assign value to it.',
+				34,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Properties/data/set-non-virtual-property-hook-assign.php

@@ -0,0 +1,68 @@
+<?php // lint >= 8.4
+
+namespace SetNonVirtualPropertyHookAssign;
+
+class Foo
+{
+
+	public int $i {
+		get {
+			return 1;
+		}
+		set {
+			// virtual property
+			$this->j = $value;
+		}
+	}
+
+	public int $j;
+
+	public int $k {
+		get {
+			return $this->k + 1;
+		}
+		set {
+			// backed property, missing assign should be reported
+			$this->j = $value;
+		}
+	}
+
+	public int $k2 {
+		get {
+			return $this->k2 + 1;
+		}
+		set {
+			// backed property, missing assign should be reported
+			if (rand(0, 1)) {
+				return;
+			}
+
+			$this->k2 = $value;
+		}
+	}
+
+	public int $k3 {
+		get {
+			return $this->k3 + 1;
+		}
+		set {
+			// backed property, always assigned (or throws)
+			if (rand(0, 1)) {
+				throw new \Exception();
+			}
+
+			$this->k3 = $value;
+		}
+	}
+
+	public int $k4 {
+		get {
+			return $this->k4 + 1;
+		}
+		set {
+			// backed property, always assigned
+			$this->k4 = $value;
+		}
+	}
+
+}