ParameterTypeHintSniff: Fixed false positive

Author: kukulich

SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSniff.php

@@ -151,6 +151,7 @@ private function checkTypeHints(File $phpcsFile, int $functionPointer, array $pa
 				$typeHints[] = AnnotationTypeHelper::getTypeHintFromOneType($parameterTypeNode);
 
 			} elseif ($parameterTypeNode instanceof UnionTypeNode || $parameterTypeNode instanceof IntersectionTypeNode) {
+				$traversableTypeHints = [];
 				foreach ($parameterTypeNode->types as $typeNode) {
 					if (!AnnotationTypeHelper::containsOneType($typeNode)) {
 						continue 2;
@@ -159,7 +160,22 @@ private function checkTypeHints(File $phpcsFile, int $functionPointer, array $pa
 					/** @var ArrayTypeNode|ArrayShapeNode|IdentifierTypeNode|ThisTypeNode|GenericTypeNode|CallableTypeNode $typeNode */
 					$typeNode = $typeNode;
 
-					$typeHints[] = AnnotationTypeHelper::getTypeHintFromOneType($typeNode);
+					$typeHint = AnnotationTypeHelper::getTypeHintFromOneType($typeNode);
+
+					if (
+						!$typeNode instanceof ArrayTypeNode
+						&& !$typeNode instanceof ArrayShapeNode
+						&& TypeHintHelper::isTraversableType(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $functionPointer, $typeHint), $this->getTraversableTypeHints())
+					) {
+						$traversableTypeHints[] = $typeHint;
+					}
+
+					$typeHints[] = $typeHint;
+				}
+
+				$traversableTypeHints = array_values(array_unique($traversableTypeHints));
+				if (count($traversableTypeHints) > 1) {
+					continue;
 				}
 			}
 

tests/Sniffs/TypeHints/ParameterTypeHintSniffTest.php

@@ -22,7 +22,7 @@ public function testErrors(): void
 			'traversableTypeHints' => ['Traversable'],
 		]);
 
-		self::assertSame(28, $report->getErrorCount());
+		self::assertSame(29, $report->getErrorCount());
 
 		self::assertSniffError($report, 6, ParameterTypeHintSniff::CODE_MISSING_ANY_TYPE_HINT);
 		self::assertSniffError($report, 14, ParameterTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
@@ -52,6 +52,7 @@ public function testErrors(): void
 		self::assertSniffError($report, 164, ParameterTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 171, ParameterTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 178, ParameterTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		self::assertSniffError($report, 185, ParameterTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 
 		self::assertAllFixedInFile($report);
 	}

tests/Sniffs/TypeHints/data/parameterTypeHintErrors.fixed.php

@@ -174,4 +174,11 @@ public function nullable(?int $a)
 	{
 	}
 
+	/**
+	 * @param mixed[]|array $a
+	 */
+	public function traversableArray(array $a)
+	{
+	}
+
 }

tests/Sniffs/TypeHints/data/parameterTypeHintErrors.php

@@ -179,4 +179,11 @@ public function nullable($a)
 	{
 	}
 
+	/**
+	 * @param mixed[]|array $a
+	 */
+	public function traversableArray($a)
+	{
+	}
+
 }

tests/Sniffs/TypeHints/data/parameterTypeHintNoErrors.php

@@ -1,5 +1,6 @@
 <?php
 
+use Doctrine\Common\Collections\ArrayCollection;
 use SlevomatCodingStandard\Helpers\ParameterTypeHint;
 use SlevomatCodingStandard\Helpers\PropertyTypeHint;
 use SlevomatCodingStandard\Helpers\ReturnTypeHint;
@@ -175,4 +176,11 @@ public function unionWithDifferentNullableBase($a)
 	{
 	}
 
+	/**
+	 * @param mixed[]|array|Traversable $a
+	 */
+	public function moreTraverasableTypes($a)
+	{
+	}
+
 }