← Back to branch summary

~ubuntu-branches/ubuntu/vivid/php-codesniffer/vivid

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.4/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot, Greg Sherwood, Alexey, Emily, David Prévot
  • Date: 2014-09-26 13:44:35 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140926134435-wvjq16miqq4d60y0
Tags: 1.5.5-1
[ Greg Sherwood ]
* Improved closure support in Generic ScopeIndentSniff
* Improved indented PHP tag support in Generic ScopeIndentSniff
* Standards can now be located within hidden directories
 (further fix for bug #20323)
* Fixed bug #20373 : Inline comment sniff tab handling way
* Fixed bug #20378 : Report appended to existing file if no errors
  found in run
* Fixed bug #20381 : Invalid "Comment closer must be on a new line"
* PHP tokenizer no longer converts class/function names to special
  tokens types
* Fixed bug #20386 : Squiz.Commenting.ClassComment.SpacingBefore
  thrown if first block comment
* Squiz and PEAR FunctionCommentSnif now support _()
* PEAR ValidFunctionNameSniff no longer throws an error for _()
* Fixed bug #248 : FunctionCommentSniff expects ampersand on param name
* Fixed bug #248 in Squiz sniff as well
* Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff
* Prepare for 1.5.5 release

[ Alexey ]
* Allowed single undersored methods and functions

[ Emily ]
* Added var_dump to discouraged functions sniff

[ David Prévot ]
* Revert "Add XS-Testsuite still needed for ci.d.n"
* Add self to uploaders
* Bump standards version to 3.9.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.4/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php
1
 
<?php
2
 
/**
3
 
 * Squiz_Sniffs_WhiteSpace_LanguageConstructSpacingSniff.
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
 
 * Squiz_Sniffs_WhiteSpace_LanguageConstructSpacingSniff.
18
 
 *
19
 
 * Ensures all language constructs (without brackets) contain a
20
 
 * single space between themselves and their content.
21
 
 *
22
 
 * @category  PHP
23
 
 * @package   PHP_CodeSniffer
24
 
 * @author    Greg Sherwood <gsherwood@squiz.net>
25
 
 * @author    Marc McIntyre <mmcintyre@squiz.net>
26
 
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
27
 
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
28
 
 * @version   Release: 1.5.4
29
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
30
 
 */
31
 
class Squiz_Sniffs_WhiteSpace_LanguageConstructSpacingSniff implements PHP_CodeSniffer_Sniff
32
 
{
33
 
 
34
 
 
35
 
    /**
36
 
     * Returns an array of tokens this test wants to listen for.
37
 
     *
38
 
     * @return array
39
 
     */
40
 
    public function register()
41
 
    {
42
 
        return array(
43
 
                T_ECHO,
44
 
                T_PRINT,
45
 
                T_RETURN,
46
 
                T_INCLUDE,
47
 
                T_INCLUDE_ONCE,
48
 
                T_REQUIRE,
49
 
                T_REQUIRE_ONCE,
50
 
                T_NEW,
51
 
               );
52
 
 
53
 
    }//end register()
54
 
 
55
 
 
56
 
    /**
57
 
     * Processes this test, 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 in
61
 
     *                                        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
 
        if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) {
70
 
            // No content for this language construct.
71
 
            return;
72
 
        }
73
 
 
74
 
        if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
75
 
            $content       = $tokens[($stackPtr + 1)]['content'];
76
 
            $contentLength = strlen($content);
77
 
            if ($contentLength !== 1) {
78
 
                $error = 'Language constructs must be followed by a single space; expected 1 space but found %s';
79
 
                $data  = array($contentLength);
80
 
                $phpcsFile->addError($error, $stackPtr, 'IncorrectSingle', $data);
81
 
            }
82
 
        } else {
83
 
            $error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"';
84
 
            $data  = array(
85
 
                      $tokens[$stackPtr]['content'].' '.$tokens[($stackPtr + 1)]['content'],
86
 
                      $tokens[$stackPtr]['content'].$tokens[($stackPtr + 1)]['content'],
87
 
                     );
88
 
            $phpcsFile->addError($error, $stackPtr, 'Incorrect', $data);
89
 
        }
90
 
 
91
 
    }//end process()
92
 
 
93
 
 
94
 
}//end class
95
 
 
96
 
?>