Process every variable in compact separately

Author: sirbrillig

VariableAnalysis/Lib/Helpers.php

@@ -445,6 +445,64 @@ public static function findVariableScope(File $phpcsFile, $stackPtr, $varName =
 		return self::findVariableScopeExceptArrowFunctions($phpcsFile, $stackPtr);
 	}
 
+	/**
+	 * Return the variable names of each variable targetted by a `compact()` call.
+	 *
+	 * @param File                   $phpcsFile
+	 * @param int                    $stackPtr
+	 * @param array<int, array<int>> $arguments The stack pointers of each argument; see findFunctionCallArguments
+	 *
+	 * @return string[]
+	 */
+	public static function getVariableNamesFromCompact(File $phpcsFile, $stackPtr, $arguments)
+	{
+		$tokens = $phpcsFile->getTokens();
+		$variableNames = [];
+
+		foreach ($arguments as $argumentPtrs) {
+			$argumentPtrs = array_values(array_filter($argumentPtrs, function ($argumentPtr) use ($tokens) {
+				return isset(Tokens::$emptyTokens[$tokens[$argumentPtr]['code']]) === false;
+			}));
+			if (empty($argumentPtrs)) {
+				continue;
+			}
+			if (!isset($tokens[$argumentPtrs[0]])) {
+				continue;
+			}
+			$argumentFirstToken = $tokens[$argumentPtrs[0]];
+			if ($argumentFirstToken['code'] === T_ARRAY) {
+				// It's an array argument, recurse.
+				$arrayArguments = Helpers::findFunctionCallArguments($phpcsFile, $argumentPtrs[0]);
+				$variableNames = array_merge($variableNames, self::getVariableNamesFromCompact($phpcsFile, $stackPtr, $arrayArguments));
+				continue;
+			}
+			if (count($argumentPtrs) > 1) {
+				// Complex argument, we can't handle it, ignore.
+				continue;
+			}
+			if ($argumentFirstToken['code'] === T_CONSTANT_ENCAPSED_STRING) {
+				// Single-quoted string literal, ie compact('whatever').
+				// Substr is to strip the enclosing single-quotes.
+				$varName = substr($argumentFirstToken['content'], 1, -1);
+				$variableNames[] = $varName;
+				continue;
+			}
+			if ($argumentFirstToken['code'] === T_DOUBLE_QUOTED_STRING) {
+				// Double-quoted string literal.
+				$regexp = Constants::getDoubleQuotedVarRegexp();
+				if (! empty($regexp) && preg_match($regexp, $argumentFirstToken['content'])) {
+					// Bail if the string needs variable expansion, that's runtime stuff.
+					continue;
+				}
+				// Substr is to strip the enclosing double-quotes.
+				$varName = substr($argumentFirstToken['content'], 1, -1);
+				$variableNames[] = $varName;
+				continue;
+			}
+		}
+		return $variableNames;
+	}
+
 	/**
 	 * Return the token index of the scope start for a token
 	 *

VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php

@@ -1869,61 +1869,6 @@ protected function processVariableInString(File $phpcsFile, $stackPtr)
 		}
 	}
 
-	/**
-	 * @param File                   $phpcsFile
-	 * @param int                    $stackPtr
-	 * @param array<int, array<int>> $arguments The stack pointers of each argument
-	 * @param int                    $currScope
-	 *
-	 * @return void
-	 */
-	protected function processCompactArguments(File $phpcsFile, $stackPtr, $arguments, $currScope)
-	{
-		$tokens = $phpcsFile->getTokens();
-
-		foreach ($arguments as $argumentPtrs) {
-			$argumentPtrs = array_values(array_filter($argumentPtrs, function ($argumentPtr) use ($tokens) {
-				return isset(Tokens::$emptyTokens[$tokens[$argumentPtr]['code']]) === false;
-			}));
-			if (empty($argumentPtrs)) {
-				continue;
-			}
-			if (!isset($tokens[$argumentPtrs[0]])) {
-				continue;
-			}
-			$argumentFirstToken = $tokens[$argumentPtrs[0]];
-			if ($argumentFirstToken['code'] === T_ARRAY) {
-				// It's an array argument, recurse.
-				$arrayArguments = Helpers::findFunctionCallArguments($phpcsFile, $argumentPtrs[0]);
-				$this->processCompactArguments($phpcsFile, $stackPtr, $arrayArguments, $currScope);
-				continue;
-			}
-			if (count($argumentPtrs) > 1) {
-				// Complex argument, we can't handle it, ignore.
-				continue;
-			}
-			if ($argumentFirstToken['code'] === T_CONSTANT_ENCAPSED_STRING) {
-				// Single-quoted string literal, ie compact('whatever').
-				// Substr is to strip the enclosing single-quotes.
-				$varName = substr($argumentFirstToken['content'], 1, -1);
-				$this->markVariableReadAndWarnIfUndefined($phpcsFile, $varName, $argumentPtrs[0], $currScope);
-				continue;
-			}
-			if ($argumentFirstToken['code'] === T_DOUBLE_QUOTED_STRING) {
-				// Double-quoted string literal.
-				$regexp = Constants::getDoubleQuotedVarRegexp();
-				if (! empty($regexp) && preg_match($regexp, $argumentFirstToken['content'])) {
-					// Bail if the string needs variable expansion, that's runtime stuff.
-					continue;
-				}
-				// Substr is to strip the enclosing double-quotes.
-				$varName = substr($argumentFirstToken['content'], 1, -1);
-				$this->markVariableReadAndWarnIfUndefined($phpcsFile, $varName, $argumentPtrs[0], $currScope);
-				continue;
-			}
-		}
-	}
-
 	/**
 	 * Called to process variables named in a call to compact().
 	 *
@@ -1934,13 +1879,18 @@ protected function processCompactArguments(File $phpcsFile, $stackPtr, $argument
 	 */
 	protected function processCompact(File $phpcsFile, $stackPtr)
 	{
-		$currScope = Helpers::findVariableScope($phpcsFile, $stackPtr);
-		if ($currScope === null) {
-			return;
-		}
+		Helpers::debug("processCompact at {$stackPtr}");
 
 		$arguments = Helpers::findFunctionCallArguments($phpcsFile, $stackPtr);
-		$this->processCompactArguments($phpcsFile, $stackPtr, $arguments, $currScope);
+		$variableNames = Helpers::getVariableNamesFromCompact($phpcsFile, $stackPtr, $arguments);
+
+		foreach ( $variableNames as $variableName ) {
+			$currScope = Helpers::findVariableScope($phpcsFile, $stackPtr, $variableName);
+			if ($currScope === null) {
+				continue;
+			}
+			$this->markVariableReadAndWarnIfUndefined($phpcsFile, $variableName, $stackPtr, $currScope);
+		}
 	}
 
 	/**