NewMagicClassConstantSniff::process() - Code Metrics - Inspection of "PHP 5.5: add new sniff to detect `::class` magic c..." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#403)

by Juliette

created 2017-04-13 02:54 UTC

NewMagicClassConstantSniff::process() C

↳ Parent: NewMagicClassConstantSniff

Complexity

Conditions	14
Paths	64

Size

Total Lines	73
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	73
rs	5.4367
c	0
b	0
f	0
cc	14
eloc	39
nc	64
nop	2

How to fix Long Method Complexity

<?php
/**
 * PHPCompatibility_Sniffs_PHP_NewMagicClassConstantSniff.
 *
 * PHP version 5.5
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */

/**
 * PHPCompatibility_Sniffs_PHP_NewMagicClassConstantSniff.
 *
 * The special ClassName::class constant is available as of PHP 5.5.0, and allows for
 * fully qualified class name resolution at compile.
 *
 * PHP version 5.5
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */
class PHPCompatibility_Sniffs_PHP_NewMagicClassConstantSniff extends PHPCompatibility_Sniff
namespace YourVendor;

class YourClass { }
{

    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        return array(T_STRING);
    }

    /**
     * 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)
    {
        $tokens = $phpcsFile->getTokens();

        if (strtolower($tokens[$stackPtr]['content']) !== 'class') {
            return;
        }

        $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true, null, true);
        if ($prevToken === false || $tokens[$prevToken]['code'] !== T_DOUBLE_COLON) {
            return;
        }

        if ($this->supportsBelow('5.4')) {
            $phpcsFile->addError(
                'The magic class constant ClassName::class was not available in PHP 5.4 or earlier',
                $stackPtr,
                'Found'
            );
        }

        /*
         * Check against invalid use of the magic `::class` constant.
         */
        if ($this->supportsAbove('5.5') === false) {
            return;
        }

        $classNameToken = $phpcsFile->findPrevious(T_STRING, ($prevToken - 1), null, false, null, true);

        // Useless if not in a namespace.
        $hasNamespace = false;
        if ($classNameToken !== false) {
            $namespace = $this->determineNamespace($phpcsFile, $classNameToken);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            if (empty($namespace) === false) {
                $hasNamespace = true;
            }
        }

        if ($hasNamespace === false) {
            $phpcsFile->addWarning(
                'Using the magic class constant ClassName::class is only useful in combination with a namespaced class',
                $stackPtr,
                'NotInNamespace'
            );
        }


        // Is the magic constant used in a file which actually contains the referenced class ?
        if ($classNameToken === false) {
            return;
        }

        $targetClassName = $tokens[$classNameToken]['content'];
        $classPtr        = $stackPtr;
        while ($classPtr > 0) {
            $classPtr = $phpcsFile->findPrevious(T_CLASS, ($classPtr - 1));

            if ($classPtr !== false) {
                $className = $phpcsFile->getDeclarationName($classPtr);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                if (!empty($className) && $className === $targetClassName) {
                    return;
                }
            }
        }

        // Still here? In that case, the magic constant is used in a file which doesn't contain the target class.
        $phpcsFile->addWarning(
            'The magic class constant ClassName::class can only be used in the same file as where the class is defined',
            $stackPtr,
            'FileDoesNotContainClass'
        );
    }
}


1			<?php
2			/**
3			* PHPCompatibility_Sniffs_PHP_NewMagicClassConstantSniff.
4			*
5			* PHP version 5.5
6			*
7			* @category PHP
8			* @package PHPCompatibility
9			* @author Juliette Reinders Folmer <[email protected]>
10			*/
11
12			/**
13			* PHPCompatibility_Sniffs_PHP_NewMagicClassConstantSniff.
14			*
15			* The special ClassName::class constant is available as of PHP 5.5.0, and allows for
16			* fully qualified class name resolution at compile.
17			*
18			* PHP version 5.5
19			*
20			* @category PHP
21			* @package PHPCompatibility
22			* @author Juliette Reinders Folmer <[email protected]>
23			*/
24			class PHPCompatibility_Sniffs_PHP_NewMagicClassConstantSniff extends PHPCompatibility_Sniff
			0 ignored issues – show Coding Style Compatibility introduced 2017-04-13 02:55 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
25			{
26
27			/**
28			* Returns an array of tokens this test wants to listen for.
29			*
30			* @return array
31			*/
32			public function register()
33			{
34			return array(T_STRING);
35			}
36
37			/**
38			* Processes this test, when one of its tokens is encountered.
39			*
40			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
41			* @param int $stackPtr The position of the current token in the
42			* stack passed in $tokens.
43			*
44			* @return void
45			*/
46			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
47			{
48			$tokens = $phpcsFile->getTokens();
49
50			if (strtolower($tokens[$stackPtr]['content']) !== 'class') {
51			return;
52			}
53
54			$prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true, null, true);
55			if ($prevToken === false \|\| $tokens[$prevToken]['code'] !== T_DOUBLE_COLON) {
56			return;
57			}
58
59			if ($this->supportsBelow('5.4')) {
60			$phpcsFile->addError(
61			'The magic class constant ClassName::class was not available in PHP 5.4 or earlier',
62			$stackPtr,
63			'Found'
64			);
65			}
66
67			/*
68			* Check against invalid use of the magic `::class` constant.
69			*/
70			if ($this->supportsAbove('5.5') === false) {
71			return;
72			}
73
74			$classNameToken = $phpcsFile->findPrevious(T_STRING, ($prevToken - 1), null, false, null, true);
75
76			// Useless if not in a namespace.
77			$hasNamespace = false;
78			if ($classNameToken !== false) {
79			$namespace = $this->determineNamespace($phpcsFile, $classNameToken);
			0 ignored issues – show Bug introduced 2017-04-13 02:55 UTC by Report Bug Copy Issue Report It seems like `$classNameToken` defined by `$phpcsFile->findPrevious...ull, false, null, true)` on line `74` can also be of type `boolean`; however, `PHPCompatibility_Sniff::determineNamespace()` 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...
80			if (empty($namespace) === false) {
81			$hasNamespace = true;
82			}
83			}
84
85			if ($hasNamespace === false) {
86			$phpcsFile->addWarning(
87			'Using the magic class constant ClassName::class is only useful in combination with a namespaced class',
88			$stackPtr,
89			'NotInNamespace'
90			);
91			}
92
93
94			// Is the magic constant used in a file which actually contains the referenced class ?
95			if ($classNameToken === false) {
96			return;
97			}
98
99			$targetClassName = $tokens[$classNameToken]['content'];
100			$classPtr = $stackPtr;
101			while ($classPtr > 0) {
102			$classPtr = $phpcsFile->findPrevious(T_CLASS, ($classPtr - 1));
103
104			if ($classPtr !== false) {
105			$className = $phpcsFile->getDeclarationName($classPtr);
			0 ignored issues – show Bug introduced 2017-04-13 02:55 UTC by Report Bug Copy Issue Report It seems like `$classPtr` defined by `$phpcsFile->findPrevious(T_CLASS, $classPtr - 1)` on line `102` 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...
106			if (!empty($className) && $className === $targetClassName) {
107			return;
108			}
109			}
110			}
111
112			// Still here? In that case, the magic constant is used in a file which doesn't contain the target class.
113			$phpcsFile->addWarning(
114			'The magic class constant ClassName::class can only be used in the same file as where the class is defined',
115			$stackPtr,
116			'FileDoesNotContainClass'
117			);
118			}
119			}
120

wimg / PHPCompatibility

Pull Request — master (#403)

NewMagicClassConstantSniff::process() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like