← Back to branch summary

~ubuntu-branches/ubuntu/utopic/php-codesniffer/utopic-proposed

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.3/CodeSniffer/Standards/PEAR/Sniffs/Commenting/InlineCommentSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot
  • Date: 2014-07-21 14:42:41 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20140721144241-g4orlcuk4jzn9mhs
Tags: 1.5.3-1
* Team upload
* Focus on stable release
* Update copyright
* Bump standards version to 3.9.5
* Update Homepage
* Use ${phppear:…} instead of hardcoding them
* Run tests in dh_auto_test
* Update patch with gbp pq
* Simplify configuration installation
* Edit package.xml to move script
* Add DEP-8 tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.3/CodeSniffer/Standards/PEAR/Sniffs/Commenting/InlineCommentSniff.php
 
1
<?php
 
2
/**
 
3
 * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
 
4
 *
 
5
 * PHP version 5
 
6
 *
 
7
 * @category  PHP
 
8
 * @package   PHP_CodeSniffer
 
9
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
10
 * @author    Marc McIntyre <mmcintyre@squiz.net>
 
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
 * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
 
18
 *
 
19
 * Checks that no perl-style comments are used.
 
20
 *
 
21
 * @category  PHP
 
22
 * @package   PHP_CodeSniffer
 
23
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
24
 * @author    Marc McIntyre <mmcintyre@squiz.net>
 
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: 1.5.3
 
28
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
29
 */
 
30
class PEAR_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sniff
 
31
{
 
32
 
 
33
 
 
34
    /**
 
35
     * Returns an array of tokens this test wants to listen for.
 
36
     *
 
37
     * @return array
 
38
     */
 
39
    public function register()
 
40
    {
 
41
        return array(T_COMMENT);
 
42
 
 
43
    }//end register()
 
44
 
 
45
 
 
46
    /**
 
47
     * Processes this test, when one of its tokens is encountered.
 
48
     *
 
49
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
50
     * @param int                  $stackPtr  The position of the current token
 
51
     *                                        in the stack passed in $tokens.
 
52
     *
 
53
     * @return void
 
54
     */
 
55
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
56
    {
 
57
        $tokens = $phpcsFile->getTokens();
 
58
 
 
59
        if ($tokens[$stackPtr]['content']{0} === '#') {
 
60
            $error  = 'Perl-style comments are not allowed. Use "// Comment."';
 
61
            $error .= ' or "/* comment */" instead.';
 
62
            $phpcsFile->addError($error, $stackPtr, 'WrongStyle');
 
63
        }
 
64
 
 
65
    }//end process()
 
66
 
 
67
 
 
68
}//end class
 
69
 
 
70
?>