ControlSignatureSniff.php in Coder 8.3.x

Namespace

Drupal\Sniffs\ControlStructures

File

coder_sniffer/Drupal/Sniffs/ControlStructures/ControlSignatureSniff.php

<?php

/**
 * Verifies that control statements conform to their coding standards.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace Drupal\Sniffs\ControlStructures;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Tokens;

/**
 * Verifies that control statements conform to their coding standards.
 *
 * Largely copied from
 * \PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ControlSignatureSniff
 * and adapted for Drupal's else on new lines.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class ControlSignatureSniff implements Sniff {

  /**
   * Returns an array of tokens this test wants to listen for.
   *
   * @return int[]
   */
  public function register() {
    return [
      T_TRY,
      T_CATCH,
      T_DO,
      T_WHILE,
      T_FOR,
      T_IF,
      T_FOREACH,
      T_ELSE,
      T_ELSEIF,
      T_SWITCH,
    ];
  }

  //end 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.
   *
   * @return void
   */
  public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile
      ->getTokens();
    if (isset($tokens[$stackPtr + 1]) === false) {
      return;
    }

    // Single space after the keyword.
    $found = 1;
    if ($tokens[$stackPtr + 1]['code'] !== T_WHITESPACE) {
      $found = 0;
    }
    else {
      if ($tokens[$stackPtr + 1]['content'] !== ' ') {
        if (strpos($tokens[$stackPtr + 1]['content'], $phpcsFile->eolChar) !== false) {
          $found = 'newline';
        }
        else {
          $found = strlen($tokens[$stackPtr + 1]['content']);
        }
      }
    }
    if ($found !== 1) {
      $error = 'Expected 1 space after %s keyword; %s found';
      $data = [
        strtoupper($tokens[$stackPtr]['content']),
        $found,
      ];
      $fix = $phpcsFile
        ->addFixableError($error, $stackPtr, 'SpaceAfterKeyword', $data);
      if ($fix === true) {
        if ($found === 0) {
          $phpcsFile->fixer
            ->addContent($stackPtr, ' ');
        }
        else {
          $phpcsFile->fixer
            ->replaceToken($stackPtr + 1, ' ');
        }
      }
    }

    // Single space after closing parenthesis.
    if (isset($tokens[$stackPtr]['parenthesis_closer']) === true && isset($tokens[$stackPtr]['scope_opener']) === true) {
      $closer = $tokens[$stackPtr]['parenthesis_closer'];
      $opener = $tokens[$stackPtr]['scope_opener'];
      $content = $phpcsFile
        ->getTokensAsString($closer + 1, $opener - $closer - 1);
      if ($content !== ' ') {
        $error = 'Expected 1 space after closing parenthesis; found %s';
        if (trim($content) === '') {
          $found = strlen($content);
        }
        else {
          $found = '"' . str_replace($phpcsFile->eolChar, '\\n', $content) . '"';
        }
        $fix = $phpcsFile
          ->addFixableError($error, $closer, 'SpaceAfterCloseParenthesis', [
          $found,
        ]);
        if ($fix === true) {
          if ($closer === $opener - 1) {
            $phpcsFile->fixer
              ->addContent($closer, ' ');
          }
          else {
            $phpcsFile->fixer
              ->beginChangeset();
            $phpcsFile->fixer
              ->addContent($closer, ' ' . $tokens[$opener]['content']);
            $phpcsFile->fixer
              ->replaceToken($opener, '');
            if ($tokens[$opener]['line'] !== $tokens[$closer]['line']) {
              $next = $phpcsFile
                ->findNext(T_WHITESPACE, $opener + 1, null, true);
              if ($tokens[$next]['line'] !== $tokens[$opener]['line']) {
                for ($i = $opener + 1; $i < $next; $i++) {
                  $phpcsFile->fixer
                    ->replaceToken($i, '');
                }
              }
            }
            $phpcsFile->fixer
              ->endChangeset();
          }
        }
      }

      //end if
    }

    //end if

    // Single newline after opening brace.
    if (isset($tokens[$stackPtr]['scope_opener']) === true) {
      $opener = $tokens[$stackPtr]['scope_opener'];
      for ($next = $opener + 1; $next < $phpcsFile->numTokens; $next++) {
        $code = $tokens[$next]['code'];
        if ($code === T_WHITESPACE || $code === T_INLINE_HTML && trim($tokens[$next]['content']) === '') {
          continue;
        }

        // Skip all empty tokens on the same line as the opener.
        if ($tokens[$next]['line'] === $tokens[$opener]['line'] && (isset(Tokens::$emptyTokens[$code]) === true || $code === T_CLOSE_TAG)) {
          continue;
        }

        // We found the first bit of a code, or a comment on the
        // following line.
        break;
      }

      //end for
      if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
        $error = 'Newline required after opening brace';
        $fix = $phpcsFile
          ->addFixableError($error, $opener, 'NewlineAfterOpenBrace');
        if ($fix === true) {
          $phpcsFile->fixer
            ->beginChangeset();
          for ($i = $opener + 1; $i < $next; $i++) {
            if (trim($tokens[$i]['content']) !== '') {
              break;
            }

            // Remove whitespace.
            $phpcsFile->fixer
              ->replaceToken($i, '');
          }
          $phpcsFile->fixer
            ->addContent($opener, $phpcsFile->eolChar);
          $phpcsFile->fixer
            ->endChangeset();
        }
      }

      //end if
    }
    else {
      if ($tokens[$stackPtr]['code'] === T_WHILE) {

        // Zero spaces after parenthesis closer.
        $closer = $tokens[$stackPtr]['parenthesis_closer'];
        $found = 0;
        if ($tokens[$closer + 1]['code'] === T_WHITESPACE) {
          if (strpos($tokens[$closer + 1]['content'], $phpcsFile->eolChar) !== false) {
            $found = 'newline';
          }
          else {
            $found = strlen($tokens[$closer + 1]['content']);
          }
        }
        if ($found !== 0) {
          $error = 'Expected 0 spaces before semicolon; %s found';
          $data = [
            $found,
          ];
          $fix = $phpcsFile
            ->addFixableError($error, $closer, 'SpaceBeforeSemicolon', $data);
          if ($fix === true) {
            $phpcsFile->fixer
              ->replaceToken($closer + 1, '');
          }
        }
      }
    }

    //end if

    // Only want to check multi-keyword structures from here on.
    if ($tokens[$stackPtr]['code'] === T_DO) {
      $closer = false;
      if (isset($tokens[$stackPtr]['scope_closer']) === true) {
        $closer = $tokens[$stackPtr]['scope_closer'];
      }

      // Do-while loops should have curly braces. This is optional in
      // Javascript.
      if ($closer === false && $tokens[$stackPtr]['code'] === T_DO && $phpcsFile->tokenizerType === 'JS') {
        $error = 'The code block in a do-while loop should be surrounded by curly braces';
        $fix = $phpcsFile
          ->addFixableError($error, $stackPtr, 'DoWhileCurlyBraces');
        $closer = $phpcsFile
          ->findNext(T_WHILE, $stackPtr);
        if ($fix === true) {
          $phpcsFile->fixer
            ->beginChangeset();

          // Append an opening curly brace followed by a newline after
          // the DO.
          $next = $phpcsFile
            ->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
          if ($next !== $stackPtr + 1) {
            $phpcsFile->fixer
              ->replaceToken($stackPtr + 1, '');
          }
          $phpcsFile->fixer
            ->addContent($stackPtr, ' {' . $phpcsFile->eolChar);

          // Prepend a closing curly brace before the WHILE and ensure
          // it is on a new line.
          $prepend = $phpcsFile->eolChar;
          if ($tokens[$closer - 1]['code'] === T_WHITESPACE) {
            $prepend = '';
            if ($tokens[$closer - 1]['content'] !== $phpcsFile->eolChar) {
              $phpcsFile->fixer
                ->replaceToken($closer - 1, $phpcsFile->eolChar);
            }
          }
          $phpcsFile->fixer
            ->addContentBefore($closer, $prepend . '} ');
          $phpcsFile->fixer
            ->endChangeset();
        }

        //end if
      }

      //end if
    }
    else {
      if ($tokens[$stackPtr]['code'] === T_ELSE || $tokens[$stackPtr]['code'] === T_ELSEIF || $tokens[$stackPtr]['code'] === T_CATCH) {
        $closer = $phpcsFile
          ->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
        if ($closer === false || $tokens[$closer]['code'] !== T_CLOSE_CURLY_BRACKET) {
          return;
        }
      }
      else {
        return;
      }
    }

    //end if
    if ($tokens[$stackPtr]['code'] === T_DO) {

      // Single space after closing brace.
      $found = 1;
      if ($tokens[$closer + 1]['code'] !== T_WHITESPACE) {
        $found = 0;
      }
      else {
        if ($tokens[$closer + 1]['content'] !== ' ') {
          if (strpos($tokens[$closer + 1]['content'], $phpcsFile->eolChar) !== false) {
            $found = 'newline';
          }
          else {
            $found = strlen($tokens[$closer + 1]['content']);
          }
        }
      }
      if ($found !== 1) {
        $error = 'Expected 1 space after closing brace; %s found';
        $data = [
          $found,
        ];
        $fix = $phpcsFile
          ->addFixableError($error, $closer, 'SpaceAfterCloseBrace', $data);
        if ($fix === true) {
          if ($found === 0) {
            $phpcsFile->fixer
              ->addContent($closer, ' ');
          }
          else {
            $phpcsFile->fixer
              ->replaceToken($closer + 1, ' ');
          }
        }
      }
    }
    else {

      // New line after closing brace.
      $found = 'newline';
      if ($tokens[$closer + 1]['code'] !== T_WHITESPACE) {
        $found = 'none';
      }
      else {
        if (strpos($tokens[$closer + 1]['content'], "\n") === false) {
          $found = 'spaces';
        }
      }
      if ($found !== 'newline') {
        $error = 'Expected newline after closing brace';
        $fix = $phpcsFile
          ->addFixableError($error, $closer, 'NewlineAfterCloseBrace');
        if ($fix === true) {
          if ($found === 'none') {
            $phpcsFile->fixer
              ->addContent($closer, "\n");
          }
          else {
            $phpcsFile->fixer
              ->replaceToken($closer + 1, "\n");
          }
        }
      }
    }

    //end if
  }

}

//end class

Classes

Name	Description
ControlSignatureSniff	Verifies that control statements conform to their coding standards.