/php/pear/PHP/CodeSniffer/Standards/Squiz/Sniffs/Objects/ObjectMemberCommaSniff.php

 1<?php
 2/**
 3 * Squiz_Sniffs_Objects_ObjectInstantiationSniff.
 4 *
 5 * PHP version 5
 6 *
 7 * @category  PHP
 8 * @package   PHP_CodeSniffer
 9 * @author    Greg Sherwood <gsherwood@squiz.net>
10 * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
11 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
12 * @link      http://pear.php.net/package/PHP_CodeSniffer
13 */
14
15/**
16 * Squiz_Sniffs_Objects_ObjectInstantiationSniff.
17 *
18 * Ensures objects are assigned to a variable when instantiated.
19 *
20 * @category  PHP
21 * @package   PHP_CodeSniffer
22 * @author    Greg Sherwood <gsherwood@squiz.net>
23 * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
24 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
25 * @version   Release: 1.3.3
26 * @link      http://pear.php.net/package/PHP_CodeSniffer
27 */
28class Squiz_Sniffs_Objects_ObjectMemberCommaSniff implements PHP_CodeSniffer_Sniff
29{
30
31    /**
32     * A list of tokenizers this sniff supports.
33     *
34     * @var array
35     */
36    public $supportedTokenizers = array('JS');
37
38
39    /**
40     * Registers the token types that this sniff wishes to listen to.
41     *
42     * @return array
43     */
44    public function register()
45    {
46        return array(T_CLOSE_CURLY_BRACKET);
47
48    }//end register()
49
50
51    /**
52     * Process the tokens that this sniff is listening for.
53     *
54     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
55     * @param int                  $stackPtr  The position in the stack where
56     *                                        the token was found.
57     *
58     * @return void
59     */
60    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
61    {
62        $tokens = $phpcsFile->getTokens();
63
64        // Only interested in orphaned braces (which are objects)
65        // and object definitions.
66        if (isset($tokens[$stackPtr]['scope_condition']) === true) {
67            $condition = $tokens[$stackPtr]['scope_condition'];
68            if ($tokens[$condition]['code'] !== T_OBJECT) {
69                return;
70            }
71        }
72
73        $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
74        if ($tokens[$prev]['code'] === T_COMMA) {
75            $error = 'Last member of object must not be followed by a comma';
76            $phpcsFile->addError($error, $prev, 'Missing');
77        }
78
79    }//end process()
80
81
82}//end class
83
84?>