UnusedPrivateElementsSniff: Fixed missing reports for write-only properties with FQN native typehints

Author: kukulich

SlevomatCodingStandard/Sniffs/Classes/UnusedPrivateElementsSniff.php

@@ -13,6 +13,7 @@
 use SlevomatCodingStandard\Helpers\SuppressHelper;
 use SlevomatCodingStandard\Helpers\TokenHelper;
 use function array_keys;
+use function array_merge;
 use function array_reverse;
 use function count;
 use function in_array;
@@ -455,7 +456,7 @@ private function getProperties(File $phpcsFile, int $classTokenPointer): array
 				break;
 			}
 
-			$visibilityModifierTokenPointer = $this->findVisibilityModifierTokenPointer($phpcsFile, $tokens, $propertyTokenPointer);
+			$visibilityModifierTokenPointer = $this->findVisibilityPointer($phpcsFile, $propertyTokenPointer);
 			if ($visibilityModifierTokenPointer === null || $tokens[$visibilityModifierTokenPointer]['code'] !== T_PRIVATE) {
 				$findPropertiesStartTokenPointer = $propertyTokenPointer + 1;
 				continue;
@@ -526,7 +527,7 @@ private function getMethods(File $phpcsFile, int $classTokenPointer): array
 				break;
 			}
 
-			$visibilityModifierTokenPointer = $this->findVisibilityModifierTokenPointer($phpcsFile, $tokens, $methodTokenPointer);
+			$visibilityModifierTokenPointer = $this->findVisibilityPointer($phpcsFile, $methodTokenPointer);
 			if ($visibilityModifierTokenPointer === null || $tokens[$visibilityModifierTokenPointer]['code'] !== T_PRIVATE) {
 				$findMethodsStartTokenPointer = $methodTokenPointer + 1;
 				continue;
@@ -592,7 +593,7 @@ private function getConstants(File $phpcsFile, int $classTokenPointer): array
 				break;
 			}
 
-			$visibilityModifierTokenPointer = $this->findVisibilityModifierTokenPointer($phpcsFile, $tokens, $constantTokenPointer);
+			$visibilityModifierTokenPointer = $this->findVisibilityPointer($phpcsFile, $constantTokenPointer);
 			if ($visibilityModifierTokenPointer === null || $tokens[$visibilityModifierTokenPointer]['code'] !== T_PRIVATE) {
 				$findConstantsStartTokenPointer = $constantTokenPointer + 1;
 				continue;
@@ -608,33 +609,34 @@ private function getConstants(File $phpcsFile, int $classTokenPointer): array
 		return $reportedConstants;
 	}
 
-	/**
-	 * @param File $phpcsFile
-	 * @param array<int, array<string, array<int, int|string>|int|string>> $tokens
-	 * @param int $methodTokenPointer
-	 * @return int|null
-	 */
-	private function findVisibilityModifierTokenPointer(File $phpcsFile, array $tokens, int $methodTokenPointer): ?int
+	private function findVisibilityPointer(File $phpcsFile, int $pointer): ?int
 	{
-		/** @var int $visibilityModifiedTokenPointer */
-		$visibilityModifiedTokenPointer = TokenHelper::findPreviousEffective($phpcsFile, $methodTokenPointer - 1);
-		$visibilityModifiedToken = $tokens[$visibilityModifiedTokenPointer];
-		if (in_array($visibilityModifiedToken['code'], [T_PUBLIC, T_PROTECTED, T_PRIVATE], true)) {
-			return $visibilityModifiedTokenPointer;
-		}
+		$tokens = $phpcsFile->getTokens();
+
+		$visibilityPointer = TokenHelper::findPreviousEffective($phpcsFile, $pointer - 1);
 
-		if (in_array($visibilityModifiedToken['code'], [T_SELF, T_STRING], true)) {
-			$mightBeNullableTokenPointer = TokenHelper::findPreviousEffective($phpcsFile, $visibilityModifiedTokenPointer - 1);
-			$mightBeNullableToken = $tokens[$mightBeNullableTokenPointer];
-			if ($mightBeNullableToken['code'] === T_NULLABLE) {
-				$visibilityModifiedTokenPointer = $mightBeNullableTokenPointer;
+		if (in_array($tokens[$visibilityPointer]['code'], [T_SELF, T_STRING], true)) {
+			$visibilityPointer = TokenHelper::findPreviousExcluding(
+				$phpcsFile,
+				array_merge(TokenHelper::$nameTokenCodes, TokenHelper::$ineffectiveTokenCodes),
+				$visibilityPointer - 1
+			);
+
+			if ($tokens[$visibilityPointer]['code'] === T_NULLABLE) {
+				$visibilityPointer = TokenHelper::findPreviousEffective($phpcsFile, $visibilityPointer - 1);
 			}
+		}
 
-			return $this->findVisibilityModifierTokenPointer($phpcsFile, $tokens, $visibilityModifiedTokenPointer);
+		if (in_array($tokens[$visibilityPointer]['code'], [T_ABSTRACT, T_STATIC], true)) {
+			$visibilityPointer = TokenHelper::findPreviousExcluding(
+				$phpcsFile,
+				array_merge([T_ABSTRACT, T_STATIC], TokenHelper::$ineffectiveTokenCodes),
+				$visibilityPointer - 1
+			);
 		}
 
-		if (in_array($visibilityModifiedToken['code'], [T_ABSTRACT, T_STATIC], true)) {
-			return $this->findVisibilityModifierTokenPointer($phpcsFile, $tokens, $visibilityModifiedTokenPointer);
+		if (in_array($tokens[$visibilityPointer]['code'], [T_PUBLIC, T_PROTECTED, T_PRIVATE], true)) {
+			return $visibilityPointer;
 		}
 
 		return null;

tests/Sniffs/Classes/UnusedPrivateElementsSniffTest.php

@@ -235,10 +235,12 @@ public function testClassWithTypedProperties(): void
 	{
 		$resultFile = self::checkFile(__DIR__ . '/data/classWithTypedProperties.php');
 
-		self::assertNoSniffError($resultFile, 6);
+		self::assertSame(4, $resultFile->getErrorCount());
+
 		self::assertSniffError($resultFile, 7, UnusedPrivateElementsSniff::CODE_WRITE_ONLY_PROPERTY);
 		self::assertSniffError($resultFile, 8, UnusedPrivateElementsSniff::CODE_WRITE_ONLY_PROPERTY);
 		self::assertSniffError($resultFile, 9, UnusedPrivateElementsSniff::CODE_WRITE_ONLY_PROPERTY);
+		self::assertSniffError($resultFile, 10, UnusedPrivateElementsSniff::CODE_WRITE_ONLY_PROPERTY);
 	}
 
 }

tests/Sniffs/Classes/data/classWithTypedProperties.php

@@ -6,13 +6,15 @@ class ClassWithTypedProperties
 	private self $self;
 	private ?self $empty;
 	private ClassWithTypedProperties $static;
+	private \ClassWithTypedProperties $static2;
 	private int $int;
 
 	public function __construct()
 	{
 		$this->self = $this;
 		$this->empty = null;
 		$this->static = $this;
+		$this->static2 = $this;
 		$this->int = 0;
 	}