1<?php
2/**
3 * Generic_Sniffs_Commenting_FixmeSniff.
4 *
5 * PHP version 5
6 *
7 * @category  PHP
8 * @package   PHP_CodeSniffer
9 * @author    Greg Sherwood <gsherwood@squiz.net>
10 * @author    Sam Graham <php-codesniffer@illusori.co.uk>
11 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
12 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
13 * @link      http://pear.php.net/package/PHP_CodeSniffer
14 */
15
16/**
17 * Generic_Sniffs_Commenting_FixmeSniff.
18 *
19 * Warns about FIXME comments.
20 *
21 * @category  PHP
22 * @package   PHP_CodeSniffer
23 * @author    Greg Sherwood <gsherwood@squiz.net>
24 * @author    Sam Graham <php-codesniffer@illusori.co.uk>
25 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
26 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
27 * @version   Release: @package_version@
28 * @link      http://pear.php.net/package/PHP_CodeSniffer
29 */
30class Generic_Sniffs_Commenting_FixmeSniff implements PHP_CodeSniffer_Sniff
31{
32
33    /**
34     * A list of tokenizers this sniff supports.
35     *
36     * @var array
37     */
38    public $supportedTokenizers = array(
39                                   'PHP',
40                                   'JS',
41                                  );
42
43
44    /**
45     * Returns an array of tokens this test wants to listen for.
46     *
47     * @return array
48     */
49    public function register()
50    {
51        return PHP_CodeSniffer_Tokens::$commentTokens;
52
53    }//end register()
54
55
56    /**
57     * Processes this sniff, when one of its tokens is encountered.
58     *
59     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
60     * @param int                  $stackPtr  The position of the current token
61     *                                        in the stack passed in $tokens.
62     *
63     * @return void
64     */
65    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
66    {
67        $tokens = $phpcsFile->getTokens();
68
69        $content = $tokens[$stackPtr]['content'];
70        $matches = array();
71        preg_match('/(?:\A|[^\p{L}]+)fixme([^\p{L}]+(.*)|\Z)/ui', $content, $matches);
72        if (empty($matches) === false) {
73            // Clear whitespace and some common characters not required at
74            // the end of a fixme message to make the error more informative.
75            $type         = 'CommentFound';
76            $fixmeMessage = trim($matches[1]);
77            $fixmeMessage = trim($fixmeMessage, '-:[](). ');
78            $error        = 'Comment refers to a FIXME task';
79            $data         = array($fixmeMessage);
80            if ($fixmeMessage !== '') {
81                $type   = 'TaskFound';
82                $error .= ' "%s"';
83            }
84
85            $phpcsFile->addError($error, $stackPtr, $type, $data);
86        }
87
88    }//end process()
89
90
91}//end class
92