PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Source for file TodoSniff.php

Documentation is available at TodoSniff.php

  1. <?php
  2. /**
  3.  * Warns about TODO comments.
  4.  *
  5.  * @author    Greg Sherwood <gsherwood@squiz.net>
  6.  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
  7.  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  8.  */
  9.  
  10. namespace PHP_CodeSniffer\Standards\Generic\Sniffs\Commenting;
  11.  
  12. use PHP_CodeSniffer\Sniffs\Sniff;
  13. use PHP_CodeSniffer\Files\File;
  14. use PHP_CodeSniffer\Util\Tokens;
  15.  
  16. class TodoSniff implements Sniff
  17. {
  18.  
  19.     /**
  20.      * A list of tokenizers this sniff supports.
  21.      *
  22.      * @var array 
  23.      */
  24.     public $supportedTokenizers = array(
  25.                                    'PHP',
  26.                                    'JS',
  27.                                   );
  28.  
  29.  
  30.     /**
  31.      * Returns an array of tokens this test wants to listen for.
  32.      *
  33.      * @return array 
  34.      */
  35.     public function register()
  36.     {
  37.         return Tokens::$commentTokens;
  38.  
  39.     }//end register()
  40.  
  41.  
  42.     /**
  43.      * Processes this sniff, when one of its tokens is encountered.
  44.      *
  45.      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
  46.      * @param int                         $stackPtr  The position of the current token
  47.      *                                                in the stack passed in $tokens.
  48.      *
  49.      * @return void 
  50.      */
  51.     public function process(File $phpcsFile$stackPtr)
  52.     {
  53.         $tokens $phpcsFile->getTokens();
  54.  
  55.         $content $tokens[$stackPtr]['content'];
  56.         $matches = array();
  57.         preg_match('/(?:\A|[^\p{L}]+)todo([^\p{L}]+(.*)|\Z)/ui'$content$matches);
  58.         if (empty($matches=== false{
  59.             // Clear whitespace and some common characters not required at
  60.             // the end of a to-do message to make the warning more informative.
  61.             $type        'CommentFound';
  62.             $todoMessage trim($matches[1]);
  63.             $todoMessage trim($todoMessage'-:[](). ');
  64.             $error       'Comment refers to a TODO task';
  65.             $data        = array($todoMessage);
  66.             if ($todoMessage !== ''{
  67.                 $type   'TaskFound';
  68.                 $error .= ' "%s"';
  69.             }
  70.  
  71.             $phpcsFile->addWarning($error$stackPtr$type$data);
  72.         }
  73.  
  74.     }//end process()
  75.  
  76.  
  77. }//end class

Documentation generated on Mon, 11 Mar 2019 15:27:48 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.