*/ protected $targetFunctions = [ 'setlocale' => true, ]; /** * Do a version check to determine if this sniff needs to run at all. * * @since 9.0.0 * * @return bool */ protected function bowOutEarly() { return (ScannedCode::shouldRunOnOrAbove('4.2') === false); } /** * Process the parameters of a matched function. * * @since 9.0.0 * * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the stack. * @param string $functionName The token content (function name) which was matched. * @param array $parameters Array with information about the parameters. * * @return int|void Integer stack pointer to skip forward or void to continue * normal file processing. */ public function processParameters(File $phpcsFile, $stackPtr, $functionName, $parameters) { $targetParam = PassedParameters::getParameterFromStack($parameters, 1, 'category'); if ($targetParam === false) { return; } $tokens = $phpcsFile->getTokens(); for ($i = $targetParam['start']; $i <= $targetParam['end']; $i++) { if ($tokens[$i]['code'] === \T_STRING || $tokens[$i]['code'] === \T_VARIABLE ) { // Variable, constant, function call. Ignore as undetermined. return; } if (isset(Tokens::$stringTokens[$tokens[$i]['code']]) === false) { continue; } $message = 'Passing the $category as a string to setlocale() has been deprecated since PHP 4.2'; $isError = false; $errorCode = 'Deprecated'; $data = [$targetParam['clean']]; if (ScannedCode::shouldRunOnOrAbove('7.0') === true) { $message .= ' and is removed since PHP 7.0'; $isError = true; $errorCode = 'Removed'; } $message .= '; Pass one of the LC_* constants instead. Found: %s'; MessageHelper::addMessage($phpcsFile, $message, $i, $isError, $errorCode, $data); break; } } }