ClassDefinitionNameSpacingSniff.php in Coder 7.2

File

coder_sniffer/Drupal/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php

<?php

/**
 * Drupal_Sniffs_CSS_ClassDefinitionNameSpacingSniff.
 *
 * PHP version 5
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */

/**
 * Ensure there are no blank lines between the names of classes/IDs. Copied from
 * Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff because of this bug:
 * https://pear.php.net/bugs/bug.php?id=19256
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class Drupal_Sniffs_CSS_ClassDefinitionNameSpacingSniff implements PHP_CodeSniffer_Sniff {

  /**
   * A list of tokenizers this sniff supports.
   *
   * @var array
   */
  public $supportedTokenizers = array(
    'CSS',
  );

  /**
   * Returns the token types that this sniff is interested in.
   *
   * @return array(int)
   */
  public function register() {
    return array(
      T_OPEN_CURLY_BRACKET,
    );
  }

  //end register()

  /**
   * Processes the tokens that this sniff is interested in.
   *
   * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
   * @param int                  $stackPtr  The position in the stack where
   *                                        the token was found.
   *
   * @return void
   */
  public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile
      ->getTokens();

    // Find the first blank line before this openning brace, unless we get
    // to another style definition, comment or the start of the file.
    $endTokens = array(
      T_CLOSE_CURLY_BRACKET,
      T_OPEN_CURLY_BRACKET,
      T_COMMENT,
      T_DOC_COMMENT,
      T_OPEN_TAG,
    );
    $foundContent = false;
    $currentLine = $tokens[$stackPtr]['line'];
    for ($i = $stackPtr - 1; $i >= 0; $i--) {
      if (in_array($tokens[$i]['code'], $endTokens) === true) {
        break;
      }

      // A comma must be followed by a new line character.
      if ($tokens[$i]['code'] === T_COMMA && strpos($tokens[$i + 1]['content'], $phpcsFile->eolChar) === false) {
        $error = 'Multiple selectors should each be on a single line';
        $phpcsFile
          ->addError($error, $i + 1, 'MultipleSelectors');
      }

      // Selectors must be on the same line.
      if ($tokens[$i]['code'] === T_WHITESPACE && strpos($tokens[$i]['content'], $phpcsFile->eolChar) !== false && in_array($tokens[$i - 1]['code'], $endTokens) === false && in_array($tokens[$i - 1]['code'], array(
        T_WHITESPACE,
        T_COMMA,
      )) == false) {
        $error = 'Selectors must be on a single line';
        $phpcsFile
          ->addError($error, $i, 'SeletorSingleLine');
      }
      if ($tokens[$i]['line'] === $currentLine) {
        if ($tokens[$i]['code'] !== T_WHITESPACE) {
          $foundContent = true;
        }
        continue;
      }

      // We changed lines.
      if ($foundContent === false) {

        // Before we throw an error, make sure we are not looking
        // at a gap before the style definition.
        $prev = $phpcsFile
          ->findPrevious(T_WHITESPACE, $i, null, true);
        if ($prev !== false && in_array($tokens[$prev]['code'], $endTokens) === false) {
          $error = 'Blank lines are not allowed between class names';
          $phpcsFile
            ->addError($error, $i + 1, 'BlankLinesFound');
        }
        break;
      }
      $foundContent = false;
      $currentLine = $tokens[$i]['line'];
    }

    //end for
  }

}

//end class

Classes

Name	Description
Drupal_Sniffs_CSS_ClassDefinitionNameSpacingSniff	Ensure there are no blank lines between the names of classes/IDs. Copied from Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff because of this bug: https://pear.php.net/bugs/bug.php?id=19256