Refactor - allow other message to be passed from getIterableTypesWithMissingValueTypehint

ondrejmirtes · ondrejmirtes · commit fd67793c2ed6 · 2026-04-30T10:39:37.000+02:00
diff --git a/src/Rules/Classes/LocalTypeAliasesCheck.php b/src/Rules/Classes/LocalTypeAliasesCheck.php
@@ -194,10 +194,9 @@ public function checkInTraitDefinitionContext(ClassReflection $reflection): arra
 				continue;
 			}
 
-			foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($resolvedType) as $iterableType) {
-				$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+			foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($resolvedType) as $iterableTypeDescription) {
 				$errors[] = RuleErrorBuilder::message(sprintf(
-					'%s %s has type alias %s with no value type specified in iterable type %s.',
+					'%s %s has type alias %s with no value type specified in %s.',
 					$reflection->getClassTypeDescription(),
 					$reflection->getDisplayName(),
 					$aliasName,
diff --git a/src/Rules/Classes/MethodTagCheck.php b/src/Rules/Classes/MethodTagCheck.php
@@ -190,10 +190,9 @@ private function checkMethodTypeInTraitDefinitionContext(ClassReflection $classR
 				->build();
 		}
 
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($type) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($type) as $iterableTypeDescription) {
 			$errors[] = RuleErrorBuilder::message(sprintf(
-				'%s %s has PHPDoc tag @method for method %s() %s with no value type specified in iterable type %s.',
+				'%s %s has PHPDoc tag @method for method %s() %s with no value type specified in %s.',
 				$classReflection->getClassTypeDescription(),
 				$classReflection->getDisplayName(),
 				$methodName,
diff --git a/src/Rules/Classes/MixinCheck.php b/src/Rules/Classes/MixinCheck.php
@@ -76,10 +76,9 @@ public function checkInTraitDefinitionContext(ClassReflection $classReflection):
 				continue;
 			}
 
-			foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($type) as $iterableType) {
-				$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+			foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($type) as $iterableTypeDescription) {
 				$errors[] = RuleErrorBuilder::message(sprintf(
-					'%s %s has PHPDoc tag @mixin with no value type specified in iterable type %s.',
+					'%s %s has PHPDoc tag @mixin with no value type specified in %s.',
 					$classReflection->getClassTypeDescription(),
 					$classReflection->getDisplayName(),
 					$iterableTypeDescription,
diff --git a/src/Rules/Classes/PropertyTagCheck.php b/src/Rules/Classes/PropertyTagCheck.php
@@ -171,10 +171,9 @@ private function checkPropertyTypeInTraitDefinitionContext(ClassReflection $clas
 				->build();
 		}
 
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($type) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($type) as $iterableTypeDescription) {
 			$errors[] = RuleErrorBuilder::message(sprintf(
-				'%s %s has PHPDoc tag %s for property $%s with no value type specified in iterable type %s.',
+				'%s %s has PHPDoc tag %s for property $%s with no value type specified in %s.',
 				$classReflection->getClassTypeDescription(),
 				$classReflection->getDisplayName(),
 				$tagName,
diff --git a/src/Rules/Constants/MissingClassConstantTypehintRule.php b/src/Rules/Constants/MissingClassConstantTypehintRule.php
@@ -58,10 +58,9 @@ private function processSingleConstant(ClassReflection $classReflection, string
 		}
 
 		$errors = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($constantType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($constantType) as $iterableTypeDescription) {
 			$errors[] = RuleErrorBuilder::message(sprintf(
-				'Constant %s::%s type has no value type specified in iterable type %s.',
+				'Constant %s::%s type has no value type specified in %s.',
 				$constantReflection->getDeclaringClass()->getDisplayName(),
 				$constantName,
 				$iterableTypeDescription,
diff --git a/src/Rules/Functions/MissingFunctionParameterTypehintRule.php b/src/Rules/Functions/MissingFunctionParameterTypehintRule.php
@@ -80,10 +80,9 @@ private function checkFunctionParameter(FunctionReflection $functionReflection,
 		}
 
 		$messages = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($parameterType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($parameterType) as $iterableTypeDescription) {
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Function %s() has %s with no value type specified in iterable type %s.',
+				'Function %s() has %s with no value type specified in %s.',
 				$functionReflection->getName(),
 				$parameterMessage,
 				$iterableTypeDescription,
diff --git a/src/Rules/Functions/MissingFunctionReturnTypehintRule.php b/src/Rules/Functions/MissingFunctionReturnTypehintRule.php
@@ -48,9 +48,8 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$messages = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($returnType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
-			$messages[] = RuleErrorBuilder::message(sprintf('Function %s() return type has no value type specified in iterable type %s.', $functionReflection->getName(), $iterableTypeDescription))
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($returnType) as $iterableTypeDescription) {
+			$messages[] = RuleErrorBuilder::message(sprintf('Function %s() return type has no value type specified in %s.', $functionReflection->getName(), $iterableTypeDescription))
 				->tip(MissingTypehintCheck::MISSING_ITERABLE_VALUE_TYPE_TIP)
 				->identifier('missingType.iterableValue')
 				->build();
diff --git a/src/Rules/Methods/MissingMethodParameterTypehintRule.php b/src/Rules/Methods/MissingMethodParameterTypehintRule.php
@@ -81,10 +81,9 @@ private function checkMethodParameter(MethodReflection $methodReflection, string
 		}
 
 		$messages = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($parameterType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($parameterType) as $iterableTypeDescription) {
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Method %s::%s() has %s with no value type specified in iterable type %s.',
+				'Method %s::%s() has %s with no value type specified in %s.',
 				$methodReflection->getDeclaringClass()->getDisplayName(),
 				$methodReflection->getName(),
 				$parameterMessage,
diff --git a/src/Rules/Methods/MissingMethodReturnTypehintRule.php b/src/Rules/Methods/MissingMethodReturnTypehintRule.php
@@ -54,10 +54,9 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$messages = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($returnType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($returnType) as $iterableTypeDescription) {
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Method %s::%s() return type has no value type specified in iterable type %s.',
+				'Method %s::%s() return type has no value type specified in %s.',
 				$methodReflection->getDeclaringClass()->getDisplayName(),
 				$methodReflection->getName(),
 				$iterableTypeDescription,
diff --git a/src/Rules/Methods/MissingMethodSelfOutTypeRule.php b/src/Rules/Methods/MissingMethodSelfOutTypeRule.php
@@ -45,10 +45,9 @@ public function processNode(Node $node, Scope $scope): array
 		$phpDocTagMessage = 'PHPDoc tag @phpstan-self-out';
 
 		$messages = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($selfOutType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($selfOutType) as $iterableTypeDescription) {
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Method %s::%s() has %s with no value type specified in iterable type %s.',
+				'Method %s::%s() has %s with no value type specified in %s.',
 				$classReflection->getDisplayName(),
 				$methodReflection->getName(),
 				$phpDocTagMessage,
diff --git a/src/Rules/MissingTypehintCheck.php b/src/Rules/MissingTypehintCheck.php
@@ -23,6 +23,7 @@
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeTraverser;
+use PHPStan\Type\VerbosityLevel;
 use Traversable;
 use function array_filter;
 use function array_keys;
@@ -61,21 +62,25 @@ public function __construct(
 	}
 
 	/**
-	 * @return Type[]
+	 * Each returned string is a fully formatted phrase describing the
+	 * offending type — e.g. `iterable type array` — so callers can drop it
+	 * straight into their error message without further formatting.
+	 *
+	 * @return string[]
 	 */
 	public function getIterableTypesWithMissingValueTypehint(Type $type): array
 	{
-		$iterablesWithMissingValueTypehint = [];
-		TypeTraverser::map($type, function (Type $type, callable $traverse) use (&$iterablesWithMissingValueTypehint): Type {
+		$descriptions = [];
+		TypeTraverser::map($type, function (Type $type, callable $traverse) use (&$descriptions): Type {
 			if ($type instanceof TemplateType) {
 				return $type;
 			}
 			if ($type instanceof AccessoryType) {
 				return $type;
 			}
 			if ($type instanceof ConditionalType || $type instanceof ConditionalTypeForParameter) {
-				$iterablesWithMissingValueTypehint = array_merge(
-					$iterablesWithMissingValueTypehint,
+				$descriptions = array_merge(
+					$descriptions,
 					$this->getIterableTypesWithMissingValueTypehint($type->getIf()),
 					$this->getIterableTypesWithMissingValueTypehint($type->getElse()),
 				);
@@ -85,7 +90,7 @@ public function getIterableTypesWithMissingValueTypehint(Type $type): array
 			if ($type->isIterable()->yes()) {
 				$iterableValue = $type->getIterableValueType();
 				if ($iterableValue instanceof MixedType && !$iterableValue->isExplicitMixed()) {
-					$iterablesWithMissingValueTypehint[] = $type;
+					$descriptions[] = sprintf('iterable type %s', $type->describe(VerbosityLevel::typeOnly()));
 				}
 				if ($type instanceof IntersectionType) {
 					if ($type->isList()->yes()) {
@@ -98,7 +103,7 @@ public function getIterableTypesWithMissingValueTypehint(Type $type): array
 			return $traverse($type);
 		});
 
-		return $iterablesWithMissingValueTypehint;
+		return $descriptions;
 	}
 
 	/**
diff --git a/src/Rules/PhpDoc/AssertRuleHelper.php b/src/Rules/PhpDoc/AssertRuleHelper.php
@@ -175,10 +175,9 @@ public function check(
 				continue;
 			}
 
-			foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($assertedType) as $iterableType) {
-				$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+			foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($assertedType) as $iterableTypeDescription) {
 				$errors[] = RuleErrorBuilder::message(sprintf(
-					'PHPDoc tag %s for %s has no value type specified in iterable type %s.',
+					'PHPDoc tag %s for %s has no value type specified in %s.',
 					$tagName,
 					$assertedExprString,
 					$iterableTypeDescription,
diff --git a/src/Rules/PhpDoc/InvalidPhpDocVarTagTypeRule.php b/src/Rules/PhpDoc/InvalidPhpDocVarTagTypeRule.php
@@ -16,7 +16,6 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\FileTypeMapper;
-use PHPStan\Type\VerbosityLevel;
 use function array_map;
 use function array_merge;
 use function is_string;
@@ -99,10 +98,9 @@ public function processNode(Node $node, Scope $scope): array
 			}
 
 			if ($this->checkMissingVarTagTypehint) {
-				foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($varTagType) as $iterableType) {
-					$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+				foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($varTagType) as $iterableTypeDescription) {
 					$errors[] = RuleErrorBuilder::message(sprintf(
-						'%s has no value type specified in iterable type %s.',
+						'%s has no value type specified in %s.',
 						$identifier,
 						$iterableTypeDescription,
 					))
diff --git a/src/Rules/Properties/MissingPropertyTypehintRule.php b/src/Rules/Properties/MissingPropertyTypehintRule.php
@@ -52,10 +52,9 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$messages = [];
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($propertyType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($propertyType) as $iterableTypeDescription) {
 			$messages[] = RuleErrorBuilder::message(sprintf(
-				'Property %s::$%s type has no value type specified in iterable type %s.',
+				'Property %s::$%s type has no value type specified in %s.',
 				$propertyReflection->getDeclaringClass()->getDisplayName(),
 				$node->getName(),
 				$iterableTypeDescription,
diff --git a/src/Rules/Properties/SetPropertyHookParameterRule.php b/src/Rules/Properties/SetPropertyHookParameterRule.php
@@ -119,10 +119,9 @@ public function processNode(Node $node, Scope $scope): array
 			return $errors;
 		}
 
-		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($parameterType) as $iterableType) {
-			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($parameterType) as $iterableTypeDescription) {
 			$errors[] = RuleErrorBuilder::message(sprintf(
-				'Set hook for property %s::$%s has parameter $%s with no value type specified in iterable type %s.',
+				'Set hook for property %s::$%s has parameter $%s with no value type specified in %s.',
 				$classReflection->getDisplayName(),
 				$hookReflection->getHookedPropertyName(),
 				$parameter->getName(),
