Support for phpstan and psaml prefixes on @method

Author: bastien-phi

src/PhpDoc/PhpDocNodeResolver.php

@@ -125,35 +125,41 @@ public function resolveMethodTags(PhpDocNode $phpDocNode, NameScope $nameScope):
 {
 $resolved = [];
 
-foreach ($phpDocNode->getMethodTagValues() as $tagValue) {
-$parameters = [];
-foreach ($tagValue->parameters as $parameterNode) {
-$parameterName = substr($parameterNode->parameterName, 1);
-$type = $parameterNode->type !== null ? $this->typeNodeResolver->resolve($parameterNode->type, $nameScope) : new MixedType();
-if ($parameterNode->defaultValue instanceof ConstExprNullNode) {
-$type = TypeCombinator::addNull($type);
-}
-$defaultValue = null;
-if ($parameterNode->defaultValue !== null) {
-$defaultValue = $this->constExprNodeResolver->resolve($parameterNode->defaultValue);
+foreach (['@method', '@psalm-method', '@phpstan-method'] as $tagName) {
+foreach ($phpDocNode->getMethodTagValues($tagName) as $tagValue) {
+$parameters = [];
+foreach ($tagValue->parameters as $parameterNode) {
+$parameterName = substr($parameterNode->parameterName, 1);
+$type = $parameterNode->type !== null
+? $this->typeNodeResolver->resolve($parameterNode->type, $nameScope)
+: new MixedType();
+if ($parameterNode->defaultValue instanceof ConstExprNullNode) {
+$type = TypeCombinator::addNull($type);
+}
+$defaultValue = null;
+if ($parameterNode->defaultValue !== null) {
+$defaultValue = $this->constExprNodeResolver->resolve($parameterNode->defaultValue);
+}
+
+$parameters[$parameterName] = new MethodTagParameter(
+$type,
+$parameterNode->isReference
+? PassedByReference::createCreatesNewVariable()
+: PassedByReference::createNo(),
+$parameterNode->isVariadic || $parameterNode->defaultValue !== null,
+$parameterNode->isVariadic,
+$defaultValue
+);
 }
 
-$parameters[$parameterName] = new MethodTagParameter(
-$type,
-$parameterNode->isReference
-? PassedByReference::createCreatesNewVariable()
-: PassedByReference::createNo(),
-$parameterNode->isVariadic || $parameterNode->defaultValue !== null,
-$parameterNode->isVariadic,
-$defaultValue
+$resolved[$tagValue->methodName] = new MethodTag(
+$tagValue->returnType !== null
+? $this->typeNodeResolver->resolve($tagValue->returnType, $nameScope)
+: new MixedType(),
+$tagValue->isStatic,
+$parameters
 );
 }
-
-$resolved[$tagValue->methodName] = new MethodTag(
-$tagValue->returnType !== null ? $this->typeNodeResolver->resolve($tagValue->returnType, $nameScope) : new MixedType(),
-$tagValue->isStatic,
-$parameters
-);
 }
 
 return $resolved;

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -10023,6 +10023,11 @@ public function dataMinMaxReturnTypeWithArrays(): array
 return $this->gatherAssertTypes(__DIR__ . '/data/minmax-arrays.php');
 }
 
+public function dataClassPhpDocs(): array
+{
+return $this->gatherAssertTypes(__DIR__ . '/data/classPhpDocs.php');
+}
+
 /**
  * @dataProvider dataBug2574
  * @dataProvider dataBug2577
@@ -10086,6 +10091,7 @@ public function dataMinMaxReturnTypeWithArrays(): array
  * @dataProvider dataNativeUnionTypes
  * @dataProvider dataMinMaxReturnTypeWithArrays
  * @dataProvider dataNativeStaticReturnType
+ * @dataProvider dataClassPhpDocs
  * @param string $assertType
  * @param string $file
  * @param mixed ...$args

tests/PHPStan/Analyser/data/classPhpDocs.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace ClassPhpDocsNamespace;
+
+use function PHPStan\Analyser\assertType;
+
+/**
+ * @method string string()
+ * @method array arrayOfStrings()
+ * @psalm-method array<string> arrayOfStrings()
+ * @phpstan-method array<string, int> arrayOfInts()
+ * @method array arrayOfInts()
+ * @method mixed overrodeMethod()
+ * @method static mixed overrodeStaticMethod()
+ */
+class Foo
+{
+ public function __call($name, $arguments){}
+
+ public static function __callStatic($name, $arguments){}
+
+ public function doFoo()
+ {
+ assertType('string', $this->string());
+ assertType('array<string>', $this->arrayOfStrings());
+ assertType('array<string, int>', $this->arrayOfInts());
+ assertType('mixed', $this->overrodeMethod());
+ assertType('mixed', static::overrodeStaticMethod());
+ }
+}
+
+/**
+ * @phpstan-method string overrodeMethod()
+ * @phpstan-method static int overrodeStaticMethod()
+ */
+class Child extends Foo
+{
+ public function doFoo()
+ {
+ assertType('string', $this->overrodeMethod());
+ assertType('int', static::overrodeStaticMethod());
+ }
+}
+