Source for file LanguageConstructSpacingSniff.php
Documentation is available at LanguageConstructSpacingSniff.php
* Ensures all language constructs contain a single space between themselves and their content.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class LanguageConstructSpacingSniff implements Sniff
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this test, 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.
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
if ($tokens[($stackPtr + 1 )]['code'] === T_SEMICOLON) {
// No content for this language construct.
if ($tokens[($stackPtr + 1 )]['code'] === T_WHITESPACE ) {
$content = $tokens[($stackPtr + 1 )]['content'];
$contentLength = strlen($content);
if ($contentLength !== 1 ) {
$error = 'Language constructs must be followed by a single space; expected 1 space but found %s';
$data = array ($contentLength);
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'IncorrectSingle', $data);
$phpcsFile->fixer ->replaceToken (($stackPtr + 1 ), ' ');
$error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"';
$tokens[$stackPtr]['content']. ' '. $tokens[($stackPtr + 1 )]['content'],
$tokens[$stackPtr]['content']. $tokens[($stackPtr + 1 )]['content'],
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'Incorrect', $data);
$phpcsFile->fixer ->addContent ($stackPtr, ' ');
Documentation generated on Mon, 11 Mar 2019 15:27:36 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|