Support for property hooks

Makefile

@@ -43,6 +43,7 @@ lint:
 		--exclude tests/PHPStan/Rules/Functions/data/arrow-function-nullsafe-by-ref.php \
 		--exclude tests/PHPStan/Levels/data/namedArguments.php \
 		--exclude tests/PHPStan/Rules/Keywords/data/continue-break.php \
+		--exclude tests/PHPStan/Rules/Keywords/data/continue-break-property-hook.php \
 		--exclude tests/PHPStan/Rules/Properties/data/invalid-callable-property-type.php \
 		--exclude tests/PHPStan/Rules/Properties/data/properties-in-interface.php \
 		--exclude tests/PHPStan/Rules/Properties/data/read-only-property.php \
@@ -89,6 +90,11 @@ lint:
 		--exclude tests/PHPStan/Rules/Properties/data/hooked-properties-without-bodies-in-class.php \
 		--exclude tests/PHPStan/Rules/Classes/data/bug-12281.php \
 		--exclude tests/PHPStan/Rules/Traits/data/bug-12281.php \
+		--exclude tests/PHPStan/Rules/Classes/data/invalid-hooked-properties.php \
+		--exclude tests/PHPStan/Parser/data/cleaning-property-hooks-before.php \
+		--exclude tests/PHPStan/Parser/data/cleaning-property-hooks-after.php \
+		--exclude tests/PHPStan/Rules/Properties/data/existing-classes-property-hooks.php \
+		--exclude tests/PHPStan/Rules/Properties/data/set-property-hook-parameter.php \
 		src tests
 
 cs:

build/collision-detector.json

@@ -5,6 +5,8 @@
 		"../tests/PHPStan/Analyser/data/multipleParseErrors.php",
 		"../tests/PHPStan/Parser/data/cleaning-1-before.php",
 		"../tests/PHPStan/Parser/data/cleaning-1-after.php",
+		"../tests/PHPStan/Parser/data/cleaning-property-hooks-before.php",
+		"../tests/PHPStan/Parser/data/cleaning-property-hooks-after.php",
 		"../tests/PHPStan/Rules/Functions/data/duplicate-function.php",
 		"../tests/PHPStan/Rules/Classes/data/duplicate-class.php",
 		"../tests/PHPStan/Rules/Names/data/multiple-namespaces.php",

conf/config.level0.neon

@@ -92,11 +92,13 @@ 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
 	- PHPStan\Rules\Properties\PropertiesInInterfaceRule
 	- PHPStan\Rules\Properties\PropertyAttributesRule
+	- PHPStan\Rules\Properties\PropertyHookAttributesRule
 	- PHPStan\Rules\Properties\PropertyInClassRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyRule
 	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyRule
@@ -210,6 +212,14 @@ services:
 		tags:
 			- phpstan.rules.rule
 
+	-
+		class: PHPStan\Rules\Properties\SetPropertyHookParameterRule
+		arguments:
+			checkPhpDocMethodSignatures: %checkPhpDocMethodSignatures%
+			checkMissingTypehints: %checkMissingTypehints%
+		tags:
+			- phpstan.rules.rule
+
 	-
 		class: PHPStan\Rules\Properties\UninitializedPropertyRule
 

conf/config.level2.neon

@@ -52,6 +52,7 @@ rules:
 	- PHPStan\Rules\PhpDoc\IncompatibleSelfOutTypeRule
 	- PHPStan\Rules\PhpDoc\IncompatibleClassConstantPhpDocTypeRule
 	- PHPStan\Rules\PhpDoc\IncompatiblePhpDocTypeRule
+	- PHPStan\Rules\PhpDoc\IncompatiblePropertyHookPhpDocTypeRule
 	- PHPStan\Rules\PhpDoc\IncompatiblePropertyPhpDocTypeRule
 	- PHPStan\Rules\PhpDoc\InvalidThrowsPhpDocValueRule
 	- PHPStan\Rules\PhpDoc\IncompatibleParamImmediatelyInvokedCallableRule

conf/config.level3.neon

@@ -16,10 +16,13 @@ rules:
 	- PHPStan\Rules\Generators\YieldTypeRule
 	- PHPStan\Rules\Methods\ReturnTypeRule
 	- PHPStan\Rules\Properties\DefaultValueTypesAssignedToPropertiesRule
+	- PHPStan\Rules\Properties\GetNonVirtualPropertyHookReadRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyAssignRule
 	- 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
 	- PHPStan\Rules\Variables\ParameterOutExecutionEndTypeRule
@@ -66,6 +69,14 @@ services:
 		tags:
 			- phpstan.rules.rule
 
+	-
+		class: PHPStan\Rules\Exceptions\ThrowsVoidPropertyHookWithExplicitThrowPointRule
+		arguments:
+			exceptionTypeResolver: @exceptionTypeResolver
+			missingCheckedExceptionInThrows: %exceptions.check.missingCheckedExceptionInThrows%
+		tags:
+			- phpstan.rules.rule
+
 	-
 		class: PHPStan\Rules\Generators\YieldFromTypeRule
 		arguments:

conf/config.level4.neon

@@ -31,6 +31,8 @@ conditionalTags:
 		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
 	PHPStan\Rules\Exceptions\TooWideMethodThrowTypeRule:
 		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
+	PHPStan\Rules\Exceptions\TooWidePropertyHookThrowTypeRule:
+		phpstan.rules.rule: %exceptions.check.tooWideThrowType%
 
 parameters:
 	checkAdvancedIsset: true
@@ -241,6 +243,9 @@ services:
 	-
 		class: PHPStan\Rules\Exceptions\TooWideMethodThrowTypeRule
 
+	-
+		class: PHPStan\Rules\Exceptions\TooWidePropertyHookThrowTypeRule
+
 	-
 		class: PHPStan\Rules\TooWideTypehints\TooWideMethodReturnTypehintRule
 		arguments:

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:
 	-
@@ -318,6 +320,11 @@ services:
 		tags:
 			- phpstan.parser.richParserNodeVisitor
 
+	-
+		class: PHPStan\Parser\PropertyHookNameVisitor
+		tags:
+			- phpstan.parser.richParserNodeVisitor
+
 	-
 		class: PHPStan\Node\Printer\ExprPrinter
 
@@ -901,6 +908,9 @@ services:
 	-
 		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInMethodThrowsRule
 
+	-
+		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInPropertyHookThrowsRule
+
 	-
 		class: PHPStan\Rules\Exceptions\MissingCheckedExceptionInThrowsCheck
 		arguments:
@@ -1011,6 +1021,9 @@ services:
 	-
 		class: PHPStan\Rules\PhpDoc\GenericCallableRuleHelper
 
+	-
+		class: PHPStan\Rules\PhpDoc\IncompatiblePhpDocTypeCheck
+
 	-
 		class: PHPStan\Rules\PhpDoc\VarTagTypeRuleHelper
 		arguments:

src/Analyser/MutatingScope.php

@@ -7,6 +7,7 @@
 use Generator;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
+use PhpParser\Node\ComplexType;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Array_;
 use PhpParser\Node\Expr\BinaryOp;
@@ -21,6 +22,7 @@
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Identifier;
 use PhpParser\Node\InterpolatedStringPart;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
@@ -2961,6 +2963,7 @@ public function enterClassMethod(
 			new PhpMethodFromParserNodeReflection(
 				$this->getClassReflection(),
 				$classMethod,
+				null,
 				$this->getFile(),
 				$templateTypeMap,
 				$this->getRealParameterTypes($classMethod),
@@ -2986,6 +2989,90 @@ public function enterClassMethod(
 		);
 	}
 
+	/**
+	 * @param Type[] $phpDocParameterTypes
+	 */
+	public function enterPropertyHook(
+		Node\PropertyHook $hook,
+		string $propertyName,
+		Identifier|Name|ComplexType|null $nativePropertyTypeNode,
+		?Type $phpDocPropertyType,
+		array $phpDocParameterTypes,
+		?Type $throwType,
+		?string $deprecatedDescription,
+		bool $isDeprecated,
+		?string $phpDocComment,
+	): self
+	{
+		if (!$this->isInClass()) {
+			throw new ShouldNotHappenException();
+		}
+
+		$phpDocParameterTypes = array_map(fn (Type $type): Type => $this->transformStaticType(TemplateTypeHelper::toArgument($type)), $phpDocParameterTypes);
+
+		$hookName = $hook->name->toLowerString();
+		if ($hookName === 'set') {
+			if ($hook->params === []) {
+				$hook = clone $hook;
+				$hook->params = [
+					new Node\Param(new Variable('value'), null, $nativePropertyTypeNode),
+				];
+			}
+
+			$firstParam = $hook->params[0] ?? null;
+			if (
+				$firstParam !== null
+				&& $phpDocPropertyType !== null
+				&& $firstParam->var instanceof Variable
+				&& is_string($firstParam->var->name)
+			) {
+				$valueParamPhpDocType = $phpDocParameterTypes[$firstParam->var->name] ?? null;
+				if ($valueParamPhpDocType === null) {
+					$phpDocParameterTypes[$firstParam->var->name] = $this->transformStaticType(TemplateTypeHelper::toArgument($phpDocPropertyType));
+				}
+			}
+
+			$realReturnType = new VoidType();
+			$phpDocReturnType = null;
+		} elseif ($hookName === 'get') {
+			$realReturnType = $this->getFunctionType($nativePropertyTypeNode, false, false);
+			$phpDocReturnType = $phpDocPropertyType !== null ? $this->transformStaticType(TemplateTypeHelper::toArgument($phpDocPropertyType)) : null;
+		} else {
+			throw new ShouldNotHappenException();
+		}
+
+		$realParameterTypes = $this->getRealParameterTypes($hook);
+
+		return $this->enterFunctionLike(
+			new PhpMethodFromParserNodeReflection(
+				$this->getClassReflection(),
+				$hook,
+				$propertyName,
+				$this->getFile(),
+				TemplateTypeMap::createEmpty(),
+				$realParameterTypes,
+				$phpDocParameterTypes,
+				[],
+				$realReturnType,
+				$phpDocReturnType,
+				$throwType,
+				$deprecatedDescription,
+				$isDeprecated,
+				false,
+				false,
+				false,
+				true,
+				Assertions::createEmpty(),
+				null,
+				$phpDocComment,
+				[],
+				[],
+				[],
+			),
+			true,
+		);
+	}
+
 	private function transformStaticType(Type $type): Type
 	{
 		return TypeTraverser::map($type, function (Type $type, callable $traverse): Type {