PropertyHookNameVisitor is no longer needed, PHP-parser comes with propertyName attribute

ondrejmirtes · ondrejmirtes · commit 317a9974e295 · 2025-01-04T14:28:03.000+01:00
diff --git a/conf/config.neon b/conf/config.neon
@@ -320,11 +320,6 @@ services:
 		tags:
 			- phpstan.parser.richParserNodeVisitor
 
-	-
-		class: PHPStan\Parser\PropertyHookNameVisitor
-		tags:
-			- phpstan.parser.richParserNodeVisitor
-
 	-
 		class: PHPStan\Node\Printer\ExprPrinter
 
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -126,7 +126,6 @@
 use PHPStan\Parser\ImmediatelyInvokedClosureVisitor;
 use PHPStan\Parser\LineAttributesVisitor;
 use PHPStan\Parser\Parser;
-use PHPStan\Parser\PropertyHookNameVisitor;
 use PHPStan\Php\PhpVersion;
 use PHPStan\PhpDoc\PhpDocInheritanceResolver;
 use PHPStan\PhpDoc\ResolvedPhpDocBlock;
@@ -6436,7 +6435,7 @@ public function getPhpDocs(Scope $scope, Node\FunctionLike|Node\Stmt\Property $n
 		} elseif ($node instanceof Node\Stmt\Function_) {
 			$functionName = trim($scope->getNamespace() . '\\' . $node->name->name, '\\');
 		} elseif ($node instanceof Node\PropertyHook) {
-			$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+			$propertyName = $node->getAttribute('propertyName');
 			if ($propertyName !== null) {
 				$functionName = sprintf('$%s::%s', $propertyName, $node->name->toString());
 			}
diff --git a/src/Parser/CleaningVisitor.php b/src/Parser/CleaningVisitor.php
@@ -37,7 +37,7 @@ public function enterNode(Node $node): ?Node
 		}
 
 		if ($node instanceof Node\PropertyHook && is_array($node->body)) {
-			$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+			$propertyName = $node->getAttribute('propertyName');
 			if ($propertyName !== null) {
 				$node->body = $this->keepVariadicsAndYields($node->body, $propertyName);
 				return $node;
diff --git a/src/Parser/PropertyHookNameVisitor.php b/src/Parser/PropertyHookNameVisitor.php
diff --git a/src/Parser/SimpleParser.php b/src/Parser/SimpleParser.php
@@ -17,7 +17,6 @@ public function __construct(
 		private NameResolver $nameResolver,
 		private VariadicMethodsVisitor $variadicMethodsVisitor,
 		private VariadicFunctionsVisitor $variadicFunctionsVisitor,
-		private PropertyHookNameVisitor $propertyHookNameVisitor,
 	)
 	{
 	}
@@ -53,7 +52,6 @@ public function parseString(string $sourceCode): array
 		$nodeTraverser->addVisitor($this->nameResolver);
 		$nodeTraverser->addVisitor($this->variadicMethodsVisitor);
 		$nodeTraverser->addVisitor($this->variadicFunctionsVisitor);
-		$nodeTraverser->addVisitor($this->propertyHookNameVisitor);
 
 		/** @var array<Node\Stmt> */
 		return $nodeTraverser->traverse($nodes);
diff --git a/src/Reflection/InitializerExprContext.php b/src/Reflection/InitializerExprContext.php
@@ -9,7 +9,6 @@
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionFunction;
 use PHPStan\BetterReflection\Reflection\Adapter\ReflectionParameter;
 use PHPStan\BetterReflection\Reflection\ReflectionConstant;
-use PHPStan\Parser\PropertyHookNameVisitor;
 use PHPStan\Reflection\Php\PhpMethodFromParserNodeReflection;
 use PHPStan\ShouldNotHappenException;
 use function array_slice;
@@ -144,15 +143,15 @@ public static function fromStubParameter(
 		} elseif ($function instanceof ClassMethod) {
 			$functionName = $function->name->toString();
 		} elseif ($function instanceof PropertyHook) {
-			$propertyName = $function->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+			$propertyName = $function->getAttribute('propertyName');
 			$functionName = sprintf('$%s::%s', $propertyName, $function->name->toString());
 		}
 
 		$methodName = null;
 		if ($function instanceof ClassMethod && $className !== null) {
 			$methodName = sprintf('%s::%s', $className, $function->name->toString());
 		} elseif ($function instanceof PropertyHook) {
-			$propertyName = $function->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+			$propertyName = $function->getAttribute('propertyName');
 			$methodName = sprintf('%s::$%s::%s', $className, $propertyName, $function->name->toString());
 		} elseif ($function instanceof Function_ && $function->namespacedName !== null) {
 			$methodName = $function->namespacedName->toString();
diff --git a/src/Type/FileTypeMapper.php b/src/Type/FileTypeMapper.php
@@ -9,7 +9,6 @@
 use PHPStan\Broker\AnonymousClassNameHelper;
 use PHPStan\File\FileHelper;
 use PHPStan\Parser\Parser;
-use PHPStan\Parser\PropertyHookNameVisitor;
 use PHPStan\PhpDoc\PhpDocNodeResolver;
 use PHPStan\PhpDoc\PhpDocStringResolver;
 use PHPStan\PhpDoc\ResolvedPhpDocBlock;
@@ -281,7 +280,7 @@ function (Node $node) use ($fileName, $lookForTrait, &$traitFound, $traitMethodA
 				} elseif ($node instanceof Node\Stmt\Function_) {
 					$functionStack[] = ltrim(sprintf('%s\\%s', $namespace, $node->name->name), '\\');
 				} elseif ($node instanceof Node\PropertyHook) {
-					$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+					$propertyName = $node->getAttribute('propertyName');
 					if ($propertyName !== null) {
 						$functionStack[] = sprintf('$%s::%s', $propertyName, $node->name->toString());
 					}
@@ -299,7 +298,7 @@ function (Node $node) use ($fileName, $lookForTrait, &$traitFound, $traitMethodA
 
 					return null;
 				} elseif ($node instanceof Node\PropertyHook) {
-					$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+					$propertyName = $node->getAttribute('propertyName');
 					if ($propertyName !== null) {
 						$docComment = GetLastDocComment::forNode($node);
 						if ($docComment !== null) {
@@ -394,7 +393,7 @@ static function (Node $node) use (&$namespace, &$functionStack, &$classStack): v
 
 					array_pop($functionStack);
 				} elseif ($node instanceof Node\PropertyHook) {
-					$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+					$propertyName = $node->getAttribute('propertyName');
 					if ($propertyName !== null) {
 						if (count($functionStack) === 0) {
 							throw new ShouldNotHappenException();
@@ -503,7 +502,7 @@ function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFoun
 				} elseif ($node instanceof Node\Stmt\Function_) {
 					$functionStack[] = ltrim(sprintf('%s\\%s', $namespace, $node->name->name), '\\');
 				} elseif ($node instanceof Node\PropertyHook) {
-					$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+					$propertyName = $node->getAttribute('propertyName');
 					if ($propertyName !== null) {
 						$functionStack[] = sprintf('$%s::%s', $propertyName, $node->name->toString());
 					}
@@ -742,7 +741,7 @@ static function (Node $node, $callbackResult) use (&$namespace, &$functionStack,
 
 					array_pop($functionStack);
 				} elseif ($node instanceof Node\PropertyHook) {
-					$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+					$propertyName = $node->getAttribute('propertyName');
 					if ($propertyName !== null) {
 						if (count($functionStack) === 0) {
 							throw new ShouldNotHappenException();
diff --git a/tests/PHPStan/Parser/CleaningParserTest.php b/tests/PHPStan/Parser/CleaningParserTest.php
@@ -75,7 +75,6 @@ public function testParse(
 				new NameResolver(),
 				new VariadicMethodsVisitor(),
 				new VariadicFunctionsVisitor(),
-				new PropertyHookNameVisitor(),
 			),
 			new PhpVersion($phpVersionId),
 		);

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function enterNode(Node $node): ?Node`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`if ($node instanceof Node\PropertyHook && is_array($node->body)) {`
`40`		`- $propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);`
	`40`	`+ $propertyName = $node->getAttribute('propertyName');`
`41`	`41`	`if ($propertyName !== null) {`
`42`	`42`	`$node->body = $this->keepVariadicsAndYields($node->body, $propertyName);`
`43`	`43`	`return $node;`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,6 @@ public function __construct(`
`17`	`17`	`private NameResolver $nameResolver,`
`18`	`18`	`private VariadicMethodsVisitor $variadicMethodsVisitor,`
`19`	`19`	`private VariadicFunctionsVisitor $variadicFunctionsVisitor,`
`20`		`- private PropertyHookNameVisitor $propertyHookNameVisitor,`
`21`	`20`	`)`
`22`	`21`	`{`
`23`	`22`	`}`
`@@ -53,7 +52,6 @@ public function parseString(string $sourceCode): array`
`53`	`52`	`$nodeTraverser->addVisitor($this->nameResolver);`
`54`	`53`	`$nodeTraverser->addVisitor($this->variadicMethodsVisitor);`
`55`	`54`	`$nodeTraverser->addVisitor($this->variadicFunctionsVisitor);`
`56`		`- $nodeTraverser->addVisitor($this->propertyHookNameVisitor);`
`57`	`55`
`58`	`56`	`/** @var array<Node\Stmt> */`
`59`	`57`	`return $nodeTraverser->traverse($nodes);`