Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. UnnecessaryStringConcatSniff.php

class UnnecessaryStringConcatSniff

Same name in this branch
  1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Strings/UnnecessaryStringConcatSniff.php \PHP_CodeSniffer\Standards\Generic\Sniffs\Strings\UnnecessaryStringConcatSniff

Checks that two strings are not concatenated together; suggests using one string instead.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

  • class \PHP_CodeSniffer\Standards\Generic\Sniffs\Strings\UnnecessaryStringConcatSniff implements \PHP_CodeSniffer\Sniffs\Sniff
    • class \Drupal\Sniffs\Strings\UnnecessaryStringConcatSniff extends \PHP_CodeSniffer\Standards\Generic\Sniffs\Strings\UnnecessaryStringConcatSniff

Expanded class hierarchy of UnnecessaryStringConcatSniff

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php, line 24

Namespace

Drupal\Sniffs\Strings
View source
class UnnecessaryStringConcatSniff extends GenericUnnecessaryStringConcatSniff {
    
    /**
     * Processes this sniff, when one of its tokens is encountered.
     *
     * @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) {
        // Work out which type of file this is for.
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$stackPtr]['code'] === T_STRING_CONCAT) {
            if ($phpcsFile->tokenizerType === 'JS') {
                return;
            }
        }
        else {
            if ($phpcsFile->tokenizerType === 'PHP') {
                return;
            }
        }
        $prev = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
        $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
        if ($prev === false || $next === false) {
            return;
        }
        $stringTokens = Tokens::$stringTokens;
        if (in_array($tokens[$prev]['code'], $stringTokens) === true && in_array($tokens[$next]['code'], $stringTokens) === true) {
            if ($tokens[$prev]['content'][0] === $tokens[$next]['content'][0]) {
                // Before we throw an error for PHP, allow strings to be
                // combined if they would have < and ? next to each other because
                // this trick is sometimes required in PHP strings.
                if ($phpcsFile->tokenizerType === 'PHP') {
                    $prevChar = substr($tokens[$prev]['content'], -2, 1);
                    $nextChar = $tokens[$next]['content'][1];
                    $combined = $prevChar . $nextChar;
                    if ($combined === '?' . '>' || $combined === '<' . '?') {
                        return;
                    }
                }
                // Before we throw an error check if the string is longer than
                // the line length limit.
                $lineLengthLimitSniff = new LineLengthSniff();
                $lineLength = $lineLengthLimitSniff->getLineLength($phpcsFile, $tokens[$prev]['line']);
                $stringLength = $lineLength + strlen($tokens[$next]['content']) - 4;
                if ($stringLength > $lineLengthLimitSniff->lineLimit) {
                    return;
                }
                $error = 'String concat is not required here; use a single string instead';
                if ($this->error === true) {
                    $phpcsFile->addError($error, $stackPtr, 'Found');
                }
                else {
                    $phpcsFile->addWarning($error, $stackPtr, 'Found');
                }
            }
            
            //end if
        }
        
        //end if
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
UnnecessaryStringConcatSniff::$allowMultiline public property If true, strings concatenated over multiple lines are allowed.
UnnecessaryStringConcatSniff::$error public property If true, an error will be thrown; otherwise a warning.
UnnecessaryStringConcatSniff::$supportedTokenizers public property A list of tokenizers this sniff supports.
UnnecessaryStringConcatSniff::process public function Processes this sniff, when one of its tokens is encountered. Overrides UnnecessaryStringConcatSniff::process
UnnecessaryStringConcatSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal