Chris@5: <?php
Chris@5: /**
Chris@5:  * Parses and verifies comment language.
Chris@5:  *
Chris@5:  * @category PHP
Chris@5:  * @package  PHP_CodeSniffer
Chris@5:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@5:  */
Chris@5: 
Chris@5: namespace Drupal\Sniffs\Commenting;
Chris@5: 
Chris@5: use PHP_CodeSniffer\Files\File;
Chris@5: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@5: 
Chris@5: /**
Chris@5:  * Parses and verifies that comments use gender neutral language.
Chris@5:  *
Chris@5:  * @category PHP
Chris@5:  * @package  PHP_CodeSniffer
Chris@5:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@5:  */
Chris@5: class GenderNeutralCommentSniff implements Sniff
Chris@5: {
Chris@5: 
Chris@5: 
Chris@5:     /**
Chris@5:      * Returns an array of tokens this test wants to listen for.
Chris@5:      *
Chris@5:      * @return array
Chris@5:      */
Chris@5:     public function register()
Chris@5:     {
Chris@5:         return array(
Chris@5:                 T_COMMENT,
Chris@5:                 T_DOC_COMMENT_STRING,
Chris@5:                );
Chris@5: 
Chris@5:     }//end register()
Chris@5: 
Chris@5: 
Chris@5:     /**
Chris@5:      * Processes this test, when one of its tokens is encountered.
Chris@5:      *
Chris@5:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
Chris@5:      * @param int                         $stackPtr  The position of the current token
Chris@5:      *                                               in the stack passed in $tokens.
Chris@5:      *
Chris@5:      * @return void
Chris@5:      */
Chris@5:     public function process(File $phpcsFile, $stackPtr)
Chris@5:     {
Chris@5:         $tokens = $phpcsFile->getTokens();
Chris@5:         if ((bool) preg_match('/(^|\W)(he|her|hers|him|his|she)($|\W)/i', $tokens[$stackPtr]['content']) === true) {
Chris@5:             $phpcsFile->addError('Unnecessarily gendered language in a comment', $stackPtr, 'GenderNeutral');
Chris@5:         }
Chris@5: 
Chris@5:     }//end process()
Chris@5: 
Chris@5: 
Chris@5: }//end class