public function GenderNeutralCommentSniff::process in Coder 8.3

Same name and namespace in other branches

1. 8.3.x coder_sniffer/Drupal/Sniffs/Commenting/GenderNeutralCommentSniff.php \Drupal\Sniffs\Commenting\GenderNeutralCommentSniff::process()

Processes this test, 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

void

File

coder_sniffer/Drupal/Sniffs/Commenting/GenderNeutralCommentSniff.php, line 50

Class

GenderNeutralCommentSniff

Parses and verifies that comments use gender neutral language.

Namespace

Drupal\Sniffs\Commenting

Code

public function process(File $phpcsFile, $stackPtr) {
  $tokens = $phpcsFile
    ->getTokens();
  if ((bool) preg_match('/(^|\\W)(he|her|hers|him|his|she)($|\\W)/i', $tokens[$stackPtr]['content']) === true) {
    $phpcsFile
      ->addError('Unnecessarily gendered language in a comment', $stackPtr, 'GenderNeutral');
  }
}