PropertyTypeHintSniff: Fixed false positive

Author: kukulich

SlevomatCodingStandard/Sniffs/TypeHints/PropertyTypeHintSniff.php

@@ -153,6 +153,7 @@ private function checkTypeHint(
 			$typeHints[] = AnnotationTypeHelper::getTypeHintFromOneType($typeNode);
 
 		} elseif ($typeNode instanceof UnionTypeNode || $typeNode instanceof IntersectionTypeNode) {
+			$traversableTypeHints = [];
 			foreach ($typeNode->types as $innerTypeNode) {
 				if (!AnnotationTypeHelper::containsOneType($innerTypeNode)) {
 					return;
@@ -161,7 +162,22 @@ private function checkTypeHint(
 				/** @var ArrayTypeNode|ArrayShapeNode|IdentifierTypeNode|ThisTypeNode|GenericTypeNode|CallableTypeNode $innerTypeNode */
 				$innerTypeNode = $innerTypeNode;
 
-				$typeHints[] = AnnotationTypeHelper::getTypeHintFromOneType($innerTypeNode);
+				$typeHint = AnnotationTypeHelper::getTypeHintFromOneType($innerTypeNode);
+
+				if (
+					!$innerTypeNode instanceof ArrayTypeNode
+					&& !$innerTypeNode instanceof ArrayShapeNode
+					&& TypeHintHelper::isTraversableType(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $propertyPointer, $typeHint), $this->getTraversableTypeHints())
+				) {
+					$traversableTypeHints[] = $typeHint;
+				}
+
+				$typeHints[] = $typeHint;
+			}
+
+			$traversableTypeHints = array_values(array_unique($traversableTypeHints));
+			if (count($traversableTypeHints) > 1) {
+				return;
 			}
 		}
 

tests/Sniffs/TypeHints/PropertyTypeHintSniffTest.php

@@ -49,7 +49,7 @@ public function testEnabledNativeErrors(): void
 			'traversableTypeHints' => ['Traversable'],
 		]);
 
-		self::assertSame(30, $report->getErrorCount());
+		self::assertSame(31, $report->getErrorCount());
 
 		self::assertSniffError($report, 6, PropertyTypeHintSniff::CODE_MISSING_ANY_TYPE_HINT);
 		self::assertSniffError($report, 11, PropertyTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
@@ -81,6 +81,7 @@ public function testEnabledNativeErrors(): void
 		self::assertSniffError($report, 111, PropertyTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 114, PropertyTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 		self::assertSniffError($report, 117, PropertyTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
+		self::assertSniffError($report, 122, PropertyTypeHintSniff::CODE_MISSING_NATIVE_TYPE_HINT);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -103,4 +103,9 @@ class Whatever
 	/** @var ?int */
 	public ?int $nullable = null;
 
+	/**
+	 * @var mixed[]|array
+	 */
+	public array $traversableArray;
+
 }

tests/Sniffs/TypeHints/data/propertyTypeHintEnabledNativeErrors.php

@@ -116,4 +116,9 @@ class Whatever
 	/** @var ?int */
 	public $nullable;
 
+	/**
+	 * @var mixed[]|array
+	 */
+	public $traversableArray;
+
 }

tests/Sniffs/TypeHints/data/propertyTypeHintEnabledNativeNoErrors.php

@@ -118,4 +118,7 @@ class Whatever
 	 */
 	public $unionWithDifferentNullableBase;
 
+	/** @var mixed[]|array|Traversable */
+	public $moreTraverasableTypes;
+
 }