You are here

InlineControlStructureSniff.php in Coder 8.2

File

coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php
View source
<?php

/**
 * \Drupal\Sniffs\ControlStructures\InlineControlStructureSniff.
 *
 * @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\Standards\Generic\Sniffs\ControlStructures\InlineControlStructureSniff as GenericInlineControlStructureSniff;

/**
 * \Drupal\Sniffs\ControlStructures\InlineControlStructureSniff.
 *
 * Verifies that inline control statements are not present. This Sniff overides
 * the generic sniff because Drupal template files may use the alternative
 * syntax for control structures. See
 * http://www.php.net/manual/en/control-structures.alternative-syntax.php
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class InlineControlStructureSniff extends GenericInlineControlStructureSniff {

  /**
   * 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();

    // Check for the alternate syntax for control structures with colons (:).
    if (isset($tokens[$stackPtr]['parenthesis_closer']) === true) {
      $start = $tokens[$stackPtr]['parenthesis_closer'];
    }
    else {
      $start = $stackPtr;
    }
    $scopeOpener = $phpcsFile
      ->findNext(T_WHITESPACE, $start + 1, null, true);
    if ($tokens[$scopeOpener]['code'] === T_COLON) {
      return;
    }
    parent::process($phpcsFile, $stackPtr);
  }

}

//end class