ClassCreateInstanceSniff - Code Metrics - Inspection of "[upstream merge] Sniff tests are now a suite conta..." - aik099/CodingStandard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ce1586...b79486 )

by Alexander

created 2016-12-04 17:59 UTC

ClassCreateInstanceSniff A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	79
rs	10
c	0
b	0
f	0
ccs	0
cts	49
cp	0
wmc	8
lcom	0
cbo	2

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	5	1
C	process()	0	51	7

<?php
/**
 * CodingStandard_Sniffs_Classes_ClassCreateInstanceSniff.
 *
 * PHP version 5
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Peter Philipp <[email protected]>
 * @author   Alexander Obuhovich <[email protected]>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */

/**
 * Class create instance Test.
 *
 * Checks the declaration of the class is correct.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Peter Philipp <[email protected]>
 * @author   Alexander Obuhovich <[email protected]>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */
class CodingStandard_Sniffs_Classes_ClassCreateInstanceSniff implements PHP_CodeSniffer_Sniff

{


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return integer[]
     */
    public function register()
    {
        return array(T_NEW);

    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param int                  $stackPtr  The position of the current token in the
     *                                        stack passed in $tokens.
     *
     * @return void
     */
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $scopeEnd = null;
        $tokens   = $phpcsFile->getTokens();

        if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
            // New in PHP 5.4: allow to instantiate class and immediately call method on it.
            list (, $scopeEnd) = each($tokens[$stackPtr]['nested_parenthesis']);
        }

        $nextParenthesis = $phpcsFile->findNext(
            T_OPEN_PARENTHESIS,
            ($stackPtr + 1),
            $scopeEnd,
            false,
            null,
            true
        );

        if ($nextParenthesis === false || $tokens[$nextParenthesis]['line'] !== $tokens[$stackPtr]['line']) {
            $error = 'Calling class constructors must always include parentheses';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr);
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();
                $classNameEnd = $phpcsFile->findNext(
                    array(
                     T_WHITESPACE,
                     T_NS_SEPARATOR,
                     T_STRING,
                    ),
                    ($stackPtr + 1),
                    null,
                    true,
                    null,
                    true
                );

                $phpcsFile->fixer->addContentBefore($classNameEnd, '()');
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
                $phpcsFile->fixer->endChangeset();
            }//end if
        } else if ($tokens[($nextParenthesis - 1)]['code'] === T_WHITESPACE) {
            $error = 'Between the class name and the opening parenthesis spaces are not welcome';
            $fix   = $phpcsFile->addFixableError($error, ($nextParenthesis - 1));
            if ($fix === true) {
                $phpcsFile->fixer->beginChangeset();
                $phpcsFile->fixer->replaceToken(($nextParenthesis - 1), '');
                $phpcsFile->fixer->endChangeset();
            }//end if
        }//end if

    }//end process()


}//end class


1			<?php
2			/**
3			* CodingStandard_Sniffs_Classes_ClassCreateInstanceSniff.
4			*
5			* PHP version 5
6			*
7			* @category PHP
8			* @package PHP_CodeSniffer
9			* @author Peter Philipp <[email protected]>
10			* @author Alexander Obuhovich <[email protected]>
11			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
12			* @link https://github.com/aik099/CodingStandard
13			*/
14
15			/**
16			* Class create instance Test.
17			*
18			* Checks the declaration of the class is correct.
19			*
20			* @category PHP
21			* @package PHP_CodeSniffer
22			* @author Peter Philipp <[email protected]>
23			* @author Alexander Obuhovich <[email protected]>
24			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
25			* @link https://github.com/aik099/CodingStandard
26			*/
27			class CodingStandard_Sniffs_Classes_ClassCreateInstanceSniff implements PHP_CodeSniffer_Sniff
			0 ignored issues – show Coding Style introduced 2016-01-07 08:40 UTC by Report Bug Copy Issue Report This class is not in CamelCase format. Classes in PHP are usually named in CamelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. The whole name starts with a capital letter as well. Thus the name database provider becomes `DatabaseProvider`. Loading history...
28			{
29
30
31			/**
32			* Returns an array of tokens this test wants to listen for.
33			*
34			* @return integer[]
35			*/
36			public function register()
37			{
38			return array(T_NEW);
39
40			}//end register()
41
42
43			/**
44			* Processes this test, when one of its tokens is encountered.
45			*
46			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
47			* @param int $stackPtr The position of the current token in the
48			* stack passed in $tokens.
49			*
50			* @return void
51			*/
52			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
53			{
54			$scopeEnd = null;
55			$tokens = $phpcsFile->getTokens();
56
57			if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
58			// New in PHP 5.4: allow to instantiate class and immediately call method on it.
59			list (, $scopeEnd) = each($tokens[$stackPtr]['nested_parenthesis']);
60			}
61
62			$nextParenthesis = $phpcsFile->findNext(
63			T_OPEN_PARENTHESIS,
64			($stackPtr + 1),
65			$scopeEnd,
66			false,
67			null,
68			true
69			);
70
71			if ($nextParenthesis === false \|\| $tokens[$nextParenthesis]['line'] !== $tokens[$stackPtr]['line']) {
72			$error = 'Calling class constructors must always include parentheses';
73			$fix = $phpcsFile->addFixableError($error, $stackPtr);
74			if ($fix === true) {
75			$phpcsFile->fixer->beginChangeset();
76			$classNameEnd = $phpcsFile->findNext(
77			array(
78			T_WHITESPACE,
79			T_NS_SEPARATOR,
80			T_STRING,
81			),
82			($stackPtr + 1),
83			null,
84			true,
85			null,
86			true
87			);
88
89			$phpcsFile->fixer->addContentBefore($classNameEnd, '()');
			0 ignored issues – show Security Bug introduced 2016-02-13 18:14 UTC by Report Bug Copy Issue Report It seems like `$classNameEnd` defined by `$phpcsFile->findNext(arr...null, true, null, true)` on line `76` can also be of type `false`; however, `PHP_CodeSniffer_Fixer::addContentBefore()` does only seem to accept `integer`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
90			$phpcsFile->fixer->endChangeset();
91			}//end if
92			} else if ($tokens[($nextParenthesis - 1)]['code'] === T_WHITESPACE) {
93			$error = 'Between the class name and the opening parenthesis spaces are not welcome';
94			$fix = $phpcsFile->addFixableError($error, ($nextParenthesis - 1));
95			if ($fix === true) {
96			$phpcsFile->fixer->beginChangeset();
97			$phpcsFile->fixer->replaceToken(($nextParenthesis - 1), '');
98			$phpcsFile->fixer->endChangeset();
99			}//end if
100			}//end if
101
102			}//end process()
103
104
105			}//end class
106

aik099 / CodingStandard

Push — master ( ce1586...b79486 )

ClassCreateInstanceSniff A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like