Appended logic in ReferencedNameHelper for find names of class inside double quotes

Author: AIlkiv

SlevomatCodingStandard/Helpers/ReferencedNameHelper.php

@@ -9,6 +9,8 @@
 use function array_values;
 use function count;
 use function in_array;
+use function is_array;
+use function token_get_all;
 use const T_ANON_CLASS;
 use const T_ARRAY;
 use const T_AS;
@@ -23,21 +25,25 @@
 use const T_CONST;
 use const T_DECLARE;
 use const T_DOUBLE_COLON;
+use const T_DOUBLE_QUOTED_STRING;
 use const T_ELLIPSIS;
 use const T_EXTENDS;
 use const T_FUNCTION;
 use const T_GOTO;
+use const T_HEREDOC;
 use const T_IMPLEMENTS;
 use const T_INSTANCEOF;
 use const T_NAMESPACE;
 use const T_NEW;
+use const T_NS_SEPARATOR;
 use const T_NULLABLE;
 use const T_NULLSAFE_OBJECT_OPERATOR;
 use const T_OBJECT_OPERATOR;
 use const T_OPEN_PARENTHESIS;
 use const T_OPEN_SHORT_ARRAY;
 use const T_OPEN_TAG;
 use const T_PARAM_NAME;
+use const T_STRING;
 use const T_TRAIT;
 use const T_TYPE_UNION;
 use const T_USE;
@@ -128,14 +134,32 @@ private static function createAllReferencedNames(File $phpcsFile, int $openTagPo
 
 		$beginSearchAtPointer = $openTagPointer + 1;
 		$nameTokenCodes = TokenHelper::getNameTokenCodes();
-		$tokens = $phpcsFile->getTokens();
+		$nameTokenCodes[] = T_DOUBLE_QUOTED_STRING;
 
+		$tokens = $phpcsFile->getTokens();
 		while (true) {
 			$nameStartPointer = TokenHelper::findNext($phpcsFile, $nameTokenCodes, $beginSearchAtPointer);
 			if ($nameStartPointer === null) {
 				break;
 			}
 
+			// Find referenced names inside double quotes string
+			if (self::isNeedParsedContent($tokens[$nameStartPointer]['code'])) {
+				$content = $tokens[$nameStartPointer]['content'];
+				if (self::isNeedParsedContent($tokens[$nameStartPointer - 1]['code'])) {
+					$content = '"' . $content;
+				}
+				if (self::isNeedParsedContent($tokens[$nameStartPointer + 1]['code'])) {
+					$content .= '"';
+				}
+				$names = self::getReferencedNamesFromString($content);
+				foreach ($names as $name) {
+					$referencedNames[] = new ReferencedName($name, $nameStartPointer, $nameStartPointer, ReferencedName::TYPE_CLASS);
+				}
+				$beginSearchAtPointer = $nameStartPointer + 1;
+				continue;
+			}
+
 			// Attributes are parsed in specific method
 			$attributeStartPointerBefore = TokenHelper::findPrevious($phpcsFile, T_ATTRIBUTE, $nameStartPointer - 1, $beginSearchAtPointer);
 			if ($attributeStartPointerBefore !== null) {
@@ -435,4 +459,42 @@ private static function createAllReferencedNamesInAttributes(File $phpcsFile, in
 		return $referencedNames;
 	}
 
+	/**
+	 * @param int|string $code
+	 * @return bool
+	 */
+	private static function isNeedParsedContent($code): bool
+	{
+		return in_array($code, [T_DOUBLE_QUOTED_STRING, T_HEREDOC], true);
+	}
+
+	/**
+	 * @param string $content
+	 * @return string[]
+	 */
+	private static function getReferencedNamesFromString(string $content): array
+	{
+		$referencedNames = [];
+		$subTokens = token_get_all('<?php ' . $content);
+
+		foreach ($subTokens as $position => $token) {
+			if (is_array($token) && $token[0] === T_DOUBLE_COLON) {
+				$referencedName = '';
+				$tmpPosition = $position - 1;
+				while (true) {
+					if (!is_array($subTokens[$tmpPosition]) || !in_array($subTokens[$tmpPosition][0], [T_NS_SEPARATOR, T_STRING], true)) {
+						break;
+					}
+
+					$referencedName = $subTokens[$tmpPosition][1] . $referencedName;
+					$tmpPosition--;
+				}
+
+				$referencedNames[] = $referencedName;
+			}
+		}
+
+		return $referencedNames;
+	}
+
 }

tests/Helpers/ReferencedNameHelperTest.php

@@ -67,6 +67,7 @@ public function testGetAllReferencedNames(): void
 			['STR_PAD_RIGHT', false, true],
 			['EnumType', false, false],
 			['UrlGeneratorInterface', false, false],
+			['ClassInDoubleQuote', false, false],
 		];
 
 		$names = ReferencedNameHelper::getAllReferencedNames($phpcsFile, 0);

tests/Helpers/data/lotsOfReferencedNames.php

@@ -176,3 +176,17 @@ public function generateRoute($router): string
         ], referenceType: UrlGeneratorInterface::RELATIVE_PATH);
     }
 }
+
+"foo {$db->quote(ClassInDoubleQuote::SOME_CONSTANT)}";
+"foo $db->quote(FakeClassInDoubleQuote::SOME_CONSTANT)";
+
+$script .= "// @see \Foo\Bar::func()
+                \$hasDefaultValue = $hasDefaultValue;
+                /** @var \Foo\Test\Bla\Whatever */
+";
+return "
+	/** @var \\Generated\\Test\\Ide\\AutoCompletion \$locator */
+ 	\$locator = \\Foo\\Test\\Kernel\\Locator::getInstance();
+                $objName = \$locator->"
+	. '()->entity'
+	. $this->getObjectClassName() . '();';

tests/Sniffs/Namespaces/UnusedUsesSniffTest.php

@@ -66,6 +66,8 @@ public function testUnusedUse(): void
 
 		// Used class with static variable
 		self::assertNoSniffError($report, 29);
+
+		self::assertNoSniffError($report, 30);
 	}
 
 	public function testUnusedUseWithMultipleNamespaces(): void

tests/Sniffs/Namespaces/data/unusedUses.php

@@ -27,6 +27,7 @@
 use EnumClass;
 use ReferenceClass;
 use ClassWithStaticVariable;
+use ClassWithConstant;
 
 class TestClass implements FirstInterface, SecondInterface
 {
@@ -56,6 +57,8 @@ enum_type: EnumClass::VALUE(),
 			reference_type: ReferenceClass::SOME_CONSTANT
 		);
 
+		echo "test {$wrapper->escape(ClassWithConstant::FOO)}";
+
 		return new NewObject();
 	}