121 lines
3.5 KiB
PHP
121 lines
3.5 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* PHPCompatibility, an external standard for PHP_CodeSniffer.
|
||
|
|
*
|
||
|
|
* @package PHPCompatibility
|
||
|
|
* @copyright 2012-2019 PHPCompatibility Contributors
|
||
|
|
* @license https://opensource.org/licenses/LGPL-3.0 LGPL3
|
||
|
|
* @link https://github.com/PHPCompatibility/PHPCompatibility
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace PHPCompatibility\Sniffs\Syntax;
|
||
|
|
|
||
|
|
use PHPCompatibility\Sniff;
|
||
|
|
use PHP_CodeSniffer_File as File;
|
||
|
|
use PHP_CodeSniffer_Tokens as Tokens;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Detect trailing comma's in function calls, `isset()` and `unset()` as allowed since PHP 7.3.
|
||
|
|
*
|
||
|
|
* PHP version 7.3
|
||
|
|
*
|
||
|
|
* @link https://www.php.net/manual/en/migration73.new-features.php#migration73.new-features.core.trailing-commas
|
||
|
|
* @link https://wiki.php.net/rfc/trailing-comma-function-calls
|
||
|
|
*
|
||
|
|
* @since 8.2.0
|
||
|
|
* @since 9.0.0 Renamed from `NewTrailingCommaSniff` to `NewFunctionCallTrailingCommaSniff`.
|
||
|
|
*/
|
||
|
|
class NewFunctionCallTrailingCommaSniff extends Sniff
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Returns an array of tokens this test wants to listen for.
|
||
|
|
*
|
||
|
|
* @since 8.2.0
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function register()
|
||
|
|
{
|
||
|
|
return array(
|
||
|
|
\T_STRING,
|
||
|
|
\T_VARIABLE,
|
||
|
|
\T_ISSET,
|
||
|
|
\T_UNSET,
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Processes this test, when one of its tokens is encountered.
|
||
|
|
*
|
||
|
|
* @since 8.2.0
|
||
|
|
*
|
||
|
|
* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||
|
|
* @param int $stackPtr The position of the current token in
|
||
|
|
* the stack passed in $tokens.
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function process(File $phpcsFile, $stackPtr)
|
||
|
|
{
|
||
|
|
if ($this->supportsBelow('7.2') === false) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$tokens = $phpcsFile->getTokens();
|
||
|
|
|
||
|
|
$nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
|
||
|
|
if ($tokens[$nextNonEmpty]['code'] !== \T_OPEN_PARENTHESIS
|
||
|
|
|| isset($tokens[$nextNonEmpty]['parenthesis_closer']) === false
|
||
|
|
) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($tokens[$stackPtr]['code'] === \T_STRING) {
|
||
|
|
$ignore = array(
|
||
|
|
\T_FUNCTION => true,
|
||
|
|
\T_CONST => true,
|
||
|
|
\T_USE => true,
|
||
|
|
);
|
||
|
|
|
||
|
|
$prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
|
||
|
|
if (isset($ignore[$tokens[$prevNonEmpty]['code']]) === true) {
|
||
|
|
// Not a function call.
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$closer = $tokens[$nextNonEmpty]['parenthesis_closer'];
|
||
|
|
$lastInParenthesis = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($closer - 1), $nextNonEmpty, true);
|
||
|
|
|
||
|
|
if ($tokens[$lastInParenthesis]['code'] !== \T_COMMA) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$data = array();
|
||
|
|
switch ($tokens[$stackPtr]['code']) {
|
||
|
|
case \T_ISSET:
|
||
|
|
$data[] = 'calls to isset()';
|
||
|
|
$errorCode = 'FoundInIsset';
|
||
|
|
break;
|
||
|
|
|
||
|
|
case \T_UNSET:
|
||
|
|
$data[] = 'calls to unset()';
|
||
|
|
$errorCode = 'FoundInUnset';
|
||
|
|
break;
|
||
|
|
|
||
|
|
default:
|
||
|
|
$data[] = 'function calls';
|
||
|
|
$errorCode = 'FoundInFunctionCall';
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$phpcsFile->addError(
|
||
|
|
'Trailing comma\'s are not allowed in %s in PHP 7.2 or earlier',
|
||
|
|
$lastInParenthesis,
|
||
|
|
$errorCode,
|
||
|
|
$data
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|