function FileEncodingSniff::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

int|void

Overrides Sniff::process

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Files/FileEncodingSniff.php, line 61

Class

FileEncodingSniff

\Drupal\Sniffs\Files\FileEncodingSniff.

Namespace

Drupal\Sniffs\Files

Code

public function process(File $phpcsFile, $stackPtr) {
    // Not all PHP installs have the multi byte extension - nothing we can do.
    if (function_exists('mb_check_encoding') === false) {
        return $phpcsFile->numTokens;
    }
    $fileContent = $phpcsFile->getTokensAsString(0, $phpcsFile->numTokens);
    $validEncodingFound = false;
    foreach ($this->allowedEncodings as $encoding) {
        if (mb_check_encoding($fileContent, $encoding) === true) {
            $validEncodingFound = true;
        }
    }
    if ($validEncodingFound === false) {
        $warning = 'File encoding is invalid, expected %s';
        $data = [
            implode(' or ', $this->allowedEncodings),
        ];
        $phpcsFile->addWarning($warning, $stackPtr, 'InvalidEncoding', $data);
    }
    return $phpcsFile->numTokens;
}