ParameterOutAssignedTypeRule - adjust for reading the by-ref type if …

…`@param-out` is not present
phpstan · Feb 25, 2024 · 2f55c7c · 2f55c7c
1 parent 1dfe218
commit 2f55c7c
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 18 deletions.
diff --git a/src/Rules/Variables/ParameterOutAssignedTypeRule.php b/src/Rules/Variables/ParameterOutAssignedTypeRule.php
@@ -68,23 +68,26 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if ($foundParameter->getOutType() === null) {
-			return [];
+		$isParamOutType = true;
+		$outType = $foundParameter->getOutType();
+		if ($outType === null) {
+			$isParamOutType = false;
+			$outType = $foundParameter->getType();
 		}
 
 		$typeResult = $this->ruleLevelHelper->findTypeToCheck(
 			$scope,
 			$node->getAssignedExpr(),
 			'',
-			static fn (Type $type): bool => $foundParameter->getOutType()->isSuperTypeOf($type)->yes(),
+			static fn (Type $type): bool => $outType->isSuperTypeOf($type)->yes(),
 		);
 		$type = $typeResult->getType();
 		if ($type instanceof ErrorType) {
 			return $typeResult->getUnknownClassErrors();
 		}
 
 		$assignedExprType = $scope->getType($node->getAssignedExpr());
-		if ($foundParameter->getOutType()->isSuperTypeOf($assignedExprType)->yes()) {
+		if ($outType->isSuperTypeOf($assignedExprType)->yes()) {
 			return [];
 		}
 
@@ -94,16 +97,22 @@ public function processNode(Node $node, Scope $scope): array
 			$functionDescription = sprintf('function %s()', $inFunction->getName());
 		}
 
-		$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($foundParameter->getOutType(), $assignedExprType);
+		$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($outType, $assignedExprType);
+		$errorBuilder = RuleErrorBuilder::message(sprintf(
+			'Parameter &$%s %s of %s expects %s, %s given.',
+			$foundParameter->getName(),
+			$isParamOutType ? '@param-out type' : 'by-ref type',
+			$functionDescription,
+			$outType->describe($verbosityLevel),
+			$assignedExprType->describe($verbosityLevel),
+		));
+
+		if (!$isParamOutType) {
+			$errorBuilder->tip('You can change the parameter out type with @param-out PHPDoc tag.');
+		}
 
 		return [
-			RuleErrorBuilder::message(sprintf(
-				'Parameter &$%s out type of %s expects %s, %s given.',
-				$foundParameter->getName(),
-				$functionDescription,
-				$foundParameter->getOutType()->describe($verbosityLevel),
-				$assignedExprType->describe($verbosityLevel),
-			))->build(),
+			$errorBuilder->build(),
 		];
 	}
 

diff --git a/tests/PHPStan/Rules/Variables/ParameterOutAssignedTypeRuleTest.php b/tests/PHPStan/Rules/Variables/ParameterOutAssignedTypeRuleTest.php
@@ -23,29 +23,34 @@ public function testRule(): void
 	{
 		$this->analyse([__DIR__ . '/data/parameter-out-assigned-type.php'], [
 			[
-				'Parameter &$p out type of function ParameterOutAssignedType\foo() expects int, string given.',
+				'Parameter &$p @param-out type of function ParameterOutAssignedType\foo() expects int, string given.',
 				10,
 			],
 			[
-				'Parameter &$p out type of method ParameterOutAssignedType\Foo::doFoo() expects int, string given.',
+				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doFoo() expects int, string given.',
 				21,
 			],
 			[
-				'Parameter &$p out type of method ParameterOutAssignedType\Foo::doBar() expects string, int given.',
+				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doBar() expects string, int given.',
 				29,
 			],
 			[
-				'Parameter &$p out type of method ParameterOutAssignedType\Foo::doBaz() expects list<int>, array<0|int<2, max>, int> given.',
+				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doBaz() expects list<int>, array<0|int<2, max>, int> given.',
 				38,
 			],
 			[
-				'Parameter &$p out type of method ParameterOutAssignedType\Foo::doBaz2() expects list<int>, non-empty-list<\'str\'|int> given.',
+				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doBaz2() expects list<int>, non-empty-list<\'str\'|int> given.',
 				47,
 			],
 			[
-				'Parameter &$p out type of method ParameterOutAssignedType\Foo::doBaz3() expects list<list<int>>, array<int<0, max>, array<int<0, max>, int>> given.',
+				'Parameter &$p @param-out type of method ParameterOutAssignedType\Foo::doBaz3() expects list<list<int>>, array<int<0, max>, array<int<0, max>, int>> given.',
 				56,
 			],
+			[
+				'Parameter &$p by-ref type of method ParameterOutAssignedType\Foo::doNoParamOut() expects string, int given.',
+				61,
+				'You can change the parameter out type with @param-out PHPDoc tag.',
+			],
 		]);
 	}
 

diff --git a/tests/PHPStan/Rules/Variables/data/parameter-out-assigned-type.php b/tests/PHPStan/Rules/Variables/data/parameter-out-assigned-type.php
@@ -56,4 +56,14 @@ function doBaz3(&$p): void
 		unset($p[1][2]);
 	}
 
+	function doNoParamOut(string &$p): void
+	{
+		$p = 1;
+	}
+
+	function doNoParamOut2(string &$p): void
+	{
+		$p = 'foo';
+	}
+
 }