Support for offset access type syntax in annotations

Author: kukulich

SlevomatCodingStandard/Helpers/AnnotationTypeHelper.php

@@ -18,6 +18,7 @@
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
@@ -104,6 +105,13 @@ public static function getIdentifierTypeNodes(TypeNode $typeNode): array
 			);
 		}
 
+		if ($typeNode instanceof OffsetAccessTypeNode) {
+			return array_merge(
+				self::getIdentifierTypeNodes($typeNode->type),
+				self::getIdentifierTypeNodes($typeNode->offset)
+			);
+		}
+
 		/** @var IdentifierTypeNode|ThisTypeNode $typeNode */
 		$typeNode = $typeNode;
 		return [$typeNode];
@@ -174,6 +182,13 @@ public static function getConstantTypeNodes(TypeNode $typeNode): array
 			);
 		}
 
+		if ($typeNode instanceof OffsetAccessTypeNode) {
+			return array_merge(
+				self::getConstantTypeNodes($typeNode->type),
+				self::getConstantTypeNodes($typeNode->offset)
+			);
+		}
+
 		if (!$typeNode instanceof ConstTypeNode) {
 			return [];
 		}
@@ -247,6 +262,13 @@ public static function getUnionTypeNodes(TypeNode $typeNode): array
 			);
 		}
 
+		if ($typeNode instanceof OffsetAccessTypeNode) {
+			return array_merge(
+				self::getUnionTypeNodes($typeNode->type),
+				self::getUnionTypeNodes($typeNode->offset)
+			);
+		}
+
 		return [];
 	}
 
@@ -315,6 +337,13 @@ public static function getArrayTypeNodes(TypeNode $typeNode): array
 			);
 		}
 
+		if ($typeNode instanceof OffsetAccessTypeNode) {
+			return array_merge(
+				self::getArrayTypeNodes($typeNode->type),
+				self::getArrayTypeNodes($typeNode->offset)
+			);
+		}
+
 		return [];
 	}
 
@@ -447,6 +476,13 @@ public static function change(TypeNode $masterTypeNode, TypeNode $typeNodeToChan
 			);
 		}
 
+		if ($masterTypeNode instanceof OffsetAccessTypeNode) {
+			return new OffsetAccessTypeNode(
+				self::change($masterTypeNode->type, $typeNodeToChange, $changedTypeNode),
+				self::change($masterTypeNode->offset, $typeNodeToChange, $changedTypeNode)
+			);
+		}
+
 		return clone $masterTypeNode;
 	}
 

composer.json

@@ -17,7 +17,7 @@
 	"require": {
 		"php": "^7.2 || ^8.0",
 		"dealerdirect/phpcodesniffer-composer-installer": "^0.6.2 || ^0.7",
-		"phpstan/phpdoc-parser": "^1.4.1",
+		"phpstan/phpdoc-parser": "^1.5.1",
 		"squizlabs/php_codesniffer": "^3.6.2"
 	},
 	"require-dev": {

tests/Sniffs/Namespaces/ReferenceUsedNamesOnlySniffTest.php

@@ -725,7 +725,7 @@ public function testSearchingInAnnotations(): void
 			]
 		);
 
-		self::assertSame(44, $report->getErrorCount());
+		self::assertSame(50, $report->getErrorCount());
 
 		self::assertSniffError(
 			$report,
@@ -984,6 +984,43 @@ public function testSearchingInAnnotations(): void
 			'Class \Foo\Conditional10 should not be referenced via a fully qualified name, but via a use statement.'
 		);
 
+		self::assertSniffError(
+			$report,
+			172,
+			ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME,
+			'Class \Foo\OffsetAccessType should not be referenced via a fully qualified name, but via a use statement.'
+		);
+		self::assertSniffError(
+			$report,
+			172,
+			ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME,
+			'Class \Foo\OffsetAccessOffset should not be referenced via a fully qualified name, but via a use statement.'
+		);
+		self::assertSniffError(
+			$report,
+			172,
+			ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME,
+			'Class \Foo\OffsetAccessType2 should not be referenced via a fully qualified name, but via a use statement.'
+		);
+		self::assertSniffError(
+			$report,
+			172,
+			ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME,
+			'Class \Foo\OffsetAccessOffset2 should not be referenced via a fully qualified name, but via a use statement.'
+		);
+		self::assertSniffError(
+			$report,
+			172,
+			ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME,
+			'Class \Foo\OffsetAccessType3 should not be referenced via a fully qualified name, but via a use statement.'
+		);
+		self::assertSniffError(
+			$report,
+			172,
+			ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME,
+			'Class \Foo\OffsetAccessOffset3 should not be referenced via a fully qualified name, but via a use statement.'
+		);
+
 		self::assertAllFixedInFile($report);
 	}
 

tests/Sniffs/Namespaces/data/shouldBeInUseStatementSearchingInAnnotations.fixed.php

@@ -18,6 +18,12 @@
 use Foo\Conditional8;
 use Foo\Conditional9;
 use Foo\Conditional10;
+use Foo\OffsetAccessType;
+use Foo\OffsetAccessOffset;
+use Foo\OffsetAccessType2;
+use Foo\OffsetAccessOffset2;
+use Foo\OffsetAccessType3;
+use Foo\OffsetAccessOffset3;
 
 /**
  * @method \DateTimeImmutable|int|DateTime getProperty()
@@ -178,3 +184,14 @@ public function withConditionalParameter($parameter)
 	}
 
 }
+
+class OffsetAccess
+{
+
+	/**
+	 * @return OffsetAccessType[OffsetAccessOffset]|OffsetAccessType2[OffsetAccessOffset2]|OffsetAccessType3[array{offset: OffsetAccessOffset3}]
+	 */
+	public function returnOffsetAccess()
+	{}
+
+}

tests/Sniffs/Namespaces/data/shouldBeInUseStatementSearchingInAnnotations.php

@@ -164,3 +164,14 @@ public function withConditionalParameter($parameter)
 	}
 
 }
+
+class OffsetAccess
+{
+
+	/**
+	 * @return \Foo\OffsetAccessType[\Foo\OffsetAccessOffset]|\Foo\OffsetAccessType2[\Foo\OffsetAccessOffset2]|\Foo\OffsetAccessType3[array{offset: \Foo\OffsetAccessOffset3}]
+	 */
+	public function returnOffsetAccess()
+	{}
+
+}

tests/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniffTest.php

@@ -22,7 +22,7 @@ public function testErrors(): void
 			],
 		]);
 
-		self::assertSame(29, $report->getErrorCount());
+		self::assertSame(30, $report->getErrorCount());
 
 		self::assertSniffError(
 			$report,
@@ -199,6 +199,13 @@ public function testErrors(): void
 			'Usage of array type hint syntax in "float[]" is disallowed, use generic type hint syntax instead.'
 		);
 
+		self::assertSniffError(
+			$report,
+			94,
+			DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX,
+			'Usage of array type hint syntax in "string[]" is disallowed, use generic type hint syntax instead.'
+		);
+
 		self::assertAllFixedInFile($report);
 	}
 

tests/Sniffs/TypeHints/NullTypeHintOnLastPositionSniffTest.php

@@ -17,7 +17,7 @@ public function testErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/nullTypeHintOnLastPositionErrors.php');
 
-		self::assertSame(27, $report->getErrorCount());
+		self::assertSame(28, $report->getErrorCount());
 
 		self::assertSniffError($report, 7, NullTypeHintOnLastPositionSniff::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION);
 		self::assertSniffError($report, 11, NullTypeHintOnLastPositionSniff::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION);
@@ -79,6 +79,8 @@ public function testErrors(): void
 		self::assertSniffError($report, 111, NullTypeHintOnLastPositionSniff::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION);
 		self::assertSniffError($report, 118, NullTypeHintOnLastPositionSniff::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION);
 
+		self::assertSniffError($report, 130, NullTypeHintOnLastPositionSniff::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION);
+
 		self::assertAllFixedInFile($report);
 	}
 

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

@@ -91,4 +91,9 @@ public function u($parameter)
 	{
 	}
 
+	/** @return OffsetAccess[array<string>] */
+	public function v($parameter)
+	{
+	}
+
 }

tests/Sniffs/TypeHints/data/disallowArrayTypeHintSyntaxErrors.php

@@ -91,4 +91,9 @@ public function u($parameter)
 	{
 	}
 
+	/** @return OffsetAccess[string[]] */
+	public function v($parameter)
+	{
+	}
+
 }

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

@@ -122,3 +122,14 @@ public function withConditionalParameter($parameter)
 	}
 
 }
+
+class OffsetAccess
+{
+
+	/**
+	 * @return \Foo\OffsetAccessType[(\Foo\OffsetAccessOffset2|null)]
+	 */
+	public function returnOffsetAccess()
+	{}
+
+}