function FixmeSniff::process

Processes this sniff, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Commenting/FixmeSniff.php, line 52

Class

FixmeSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $content = $tokens[$stackPtr]['content'];
    $matches = [];
    preg_match('/(?:\\A|[^\\p{L}]+)fixme([^\\p{L}]+(.*)|\\Z)/ui', $content, $matches);
    if (empty($matches) === false) {
        // Clear whitespace and some common characters not required at
        // the end of a fixme message to make the error more informative.
        $type = 'CommentFound';
        $fixmeMessage = trim($matches[1]);
        $fixmeMessage = trim($fixmeMessage, '-:[](). ');
        $error = 'Comment refers to a FIXME task';
        $data = [
            $fixmeMessage,
        ];
        if ($fixmeMessage !== '') {
            $type = 'TaskFound';
            $error .= ' "%s"';
        }
        $phpcsFile->addError($error, $stackPtr, $type, $data);
    }
}