WrongParentCallSniff - 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

WrongParentCallSniff A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	48
rs	10
c	0
b	0
f	0
ccs	0
cts	20
cp	0
wmc	6
lcom	0
cbo	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	5	1
B	process()	0	20	5

<?php
/**
 * CodingStandard_Sniffs_CodeAnalysis_WrongParentCallSniff.
 *
 * 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
 */

/**
 * CodingStandard_Sniffs_CodeAnalysis_WrongParentCallSniff.
 *
 * Checks that method is invoking it's own parent and not other function.
 *
 * Correct:
 * function nameOne() {
 *     parent::nameOne();
 *
 *     ....
 * }
 *
 * Wrong:
 * function nameOne() {
 *     parent::nameTwo();
 *
 *     ....
 * }
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @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_CodeAnalysis_WrongParentCallSniff implements PHP_CodeSniffer_Sniff

{


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

    }//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)
    {
        $functionPtr = $phpcsFile->findPrevious(T_FUNCTION, ($stackPtr - 1));

        if ($functionPtr !== false) {
            $doubleColonPtr = $phpcsFile->findNext(T_DOUBLE_COLON, ($stackPtr + 1));

            if ($doubleColonPtr !== false) {
                $tokens        = $phpcsFile->getTokens();
                $functionName  = $phpcsFile->getDeclarationName($functionPtr);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $methodNamePtr = $phpcsFile->findNext(T_STRING, ($stackPtr + 1));

                if ($methodNamePtr !== false && $tokens[$methodNamePtr]['content'] !== $functionName) {
                    $error = 'Method name mismatch in parent:: call';
                    $phpcsFile->addError($error, $stackPtr, 'WrongName');
                }
            }
        }//end if

    }//end process()


}//end class


1			<?php
2			/**
3			* CodingStandard_Sniffs_CodeAnalysis_WrongParentCallSniff.
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			* CodingStandard_Sniffs_CodeAnalysis_WrongParentCallSniff.
17			*
18			* Checks that method is invoking it's own parent and not other function.
19			*
20			* Correct:
21			* function nameOne() {
22			* parent::nameOne();
23			*
24			* ....
25			* }
26			*
27			* Wrong:
28			* function nameOne() {
29			* parent::nameTwo();
30			*
31			* ....
32			* }
33			*
34			* @category PHP
35			* @package PHP_CodeSniffer
36			* @author Alexander Obuhovich <[email protected]>
37			* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
38			* @link https://github.com/aik099/CodingStandard
39			*/
40			class CodingStandard_Sniffs_CodeAnalysis_WrongParentCallSniff implements PHP_CodeSniffer_Sniff
			0 ignored issues – show Coding Style introduced 2016-01-07 08:39 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...
41			{
42
43
44			/**
45			* Returns an array of tokens this test wants to listen for.
46			*
47			* @return integer[]
48			*/
49			public function register()
50			{
51			return array(T_PARENT);
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 the
61			* stack passed in $tokens.
62			*
63			* @return void
64			*/
65			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
66			{
67			$functionPtr = $phpcsFile->findPrevious(T_FUNCTION, ($stackPtr - 1));
68
69			if ($functionPtr !== false) {
70			$doubleColonPtr = $phpcsFile->findNext(T_DOUBLE_COLON, ($stackPtr + 1));
71
72			if ($doubleColonPtr !== false) {
73			$tokens = $phpcsFile->getTokens();
74			$functionName = $phpcsFile->getDeclarationName($functionPtr);
			0 ignored issues – show Bug introduced 2016-02-13 18:14 UTC by Report Bug Copy Issue Report It seems like `$functionPtr` defined by `$phpcsFile->findPrevious...UNCTION, $stackPtr - 1)` on line `67` can also be of type `boolean`; however, `PHP_CodeSniffer_File::getDeclarationName()` does only seem to accept `integer`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
75			$methodNamePtr = $phpcsFile->findNext(T_STRING, ($stackPtr + 1));
76
77			if ($methodNamePtr !== false && $tokens[$methodNamePtr]['content'] !== $functionName) {
78			$error = 'Method name mismatch in parent:: call';
79			$phpcsFile->addError($error, $stackPtr, 'WrongName');
80			}
81			}
82			}//end if
83
84			}//end process()
85
86
87			}//end class
88

aik099 / CodingStandard

Push — master ( ce1586...b79486 )

WrongParentCallSniff A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like