DisallowLongListSyntaxSniff.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

DisallowLongListSyntaxSniff.php
View Options

	<?php
	/**
	* PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
	*
	* @package PHPCSExtra
	* @copyright 2020 PHPCSExtra Contributors
	* @license https://opensource.org/licenses/LGPL-3.0 LGPL3
	* @link https://github.com/PHPCSStandards/PHPCSExtra
	*/

	namespace PHPCSExtra\Universal\Sniffs\Lists;

	use PHP_CodeSniffer\Files\File;
	use PHP_CodeSniffer\Sniffs\Sniff;
	use PHPCSUtils\Utils\Lists;

	/**
	* Bans the use of the PHP long list syntax.
	*
	* @since 1.0.0
	*/
	final class DisallowLongListSyntaxSniff implements Sniff
	{

	/**
	* Registers the tokens that this sniff wants to listen for.
	*
	* @since 1.0.0
	*
	* @return array<int\|string>
	*/
	public function register()
	{
	return [\T_LIST];
	}

	/**
	* Processes this test, when one of its tokens is encountered.
	*
	* @since 1.0.0
	*
	* @param \PHP_CodeSniffer\Files\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)
	{
	$openClose = Lists::getOpenClose($phpcsFile, $stackPtr);
	if ($openClose === false) {
	// Live coding or parse error.
	return;
	}

	$fix = $phpcsFile->addFixableError('Long list syntax is not allowed', $stackPtr, 'Found');

	if ($fix === true) {
	$opener = $openClose['opener'];
	$closer = $openClose['closer'];

	$phpcsFile->fixer->beginChangeset();

	$phpcsFile->fixer->replaceToken($stackPtr, '');
	$phpcsFile->fixer->replaceToken($opener, '[');
	$phpcsFile->fixer->replaceToken($closer, ']');

	$phpcsFile->fixer->endChangeset();
	}
	}
	}