class JoinStringsSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\MySource\Sniffs\Strings\JoinStringsSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of JoinStringsSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ MySource/ Sniffs/ Strings/ JoinStringsSniff.php, line 18
Namespace
PHP_CodeSniffer\Standards\MySource\Sniffs\StringsView source
class JoinStringsSniff implements Sniff {
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [
'JS',
];
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_STRING,
];
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param integer $stackPtr The position of the current token
* in the stack passed in $tokens.
*
* @return void
*/
public function process(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
if ($tokens[$stackPtr]['content'] !== 'join') {
return;
}
$prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR) {
return;
}
$prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, $prev - 1, null, true);
if ($tokens[$prev]['code'] === T_CLOSE_SQUARE_BRACKET) {
$opener = $tokens[$prev]['bracket_opener'];
if ($tokens[$opener - 1]['code'] !== T_STRING) {
// This means the array is declared inline, like x = [a,b,c].join()
// and not elsewhere, like x = y[a].join()
// The first is not allowed while the second is.
$error = 'Joining strings using inline arrays is not allowed; use the + operator instead';
$phpcsFile->addError($error, $stackPtr, 'ArrayNotAllowed');
}
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
JoinStringsSniff::$supportedTokenizers | public | property | A list of tokenizers this sniff supports. | |
JoinStringsSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
JoinStringsSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |