ForbiddenClosureUseVariableNamesSniff - Code Metrics - Inspection of "PHP 7.1: New sniff to check for forbidden variable..." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#386)

by Juliette

created 2017-04-03 04:41 UTC

ForbiddenClosureUseVariableNamesSniff A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	17
lcom	1
cbo	3
dl	0
loc	91
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	5	1
C	process()	0	66	16

<?php
/**
 * PHP 7.1 Forbidden variable names in closure use statements.
 *
 * PHP version 7.1
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */

/**
 * PHP 7.1 Forbidden variable names in closure use statements.
 *
 * Variables bound to a closure via the use construct cannot use the same name
 * as any superglobals, $this, or any parameter since PHP 7.1.
 *
 * PHP version 7.1
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */
class PHPCompatibility_Sniffs_PHP_ForbiddenClosureUseVariableNamesSniff 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_USE);

    }//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)
    {
        if ($this->supportsAbove('7.1') === false) {
			return;
		}

		$tokens = $phpcsFile->getTokens();

		// Verify this use statement is used with a closure - if so, it has to have parenthesis before it.
		$previousNonEmpty = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true, null, true);
		if ($previousNonEmpty === false || $tokens[$previousNonEmpty]['code'] !== T_CLOSE_PARENTHESIS
			|| isset($tokens[$previousNonEmpty]['parenthesis_opener']) === false
		) {
			return;
		}

		// ... and (a variable within) parenthesis after it.
		$nextNonEmpty = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true, null, true);
		if ($nextNonEmpty === false || $tokens[$nextNonEmpty]['code'] !== T_OPEN_PARENTHESIS) {
			return;
		}

		if (isset($tokens[$nextNonEmpty]['parenthesis_closer']) === false) {
			// Live coding.
			return;
		}

		$closurePtr = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($tokens[$previousNonEmpty]['parenthesis_opener'] - 1), null, true );
		if ($tokens[$closurePtr]['code'] !== T_CLOSURE) {
			return;
		}

		// Get the parameters declared by the closure.
		$closureParams = $this->getMethodParameters($phpcsFile, $closurePtr);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

		$errorMsg = 'Variables bound to a closure via the use construct cannot use the same name as superglobals, $this, or a declared parameter since PHP 7.1. Found: %s';

		for ($i = ($nextNonEmpty + 1); $i < $tokens[$nextNonEmpty]['parenthesis_closer']; $i++) {
			if ($tokens[$i]['code'] !== T_VARIABLE) {
				continue;
			}
			
			$variableName = $tokens[$i]['content'];

			if ($variableName === '$this') {
				$phpcsFile->addError($errorMsg, $i, 'FoundThis', array($variableName));
				continue;
			}

			if (in_array($variableName, $this->superglobals, true) === true) {
				$phpcsFile->addError($errorMsg, $i, 'FoundSuperglobal', array($variableName));
				continue;
			}

			// Check whether it is one of the parameters declared by the closure.
			if (empty($closureParams) === false) {
				foreach ($closureParams as $param) {
					if ($param['name'] === $variableName) {
						$phpcsFile->addError($errorMsg, $i, 'FoundShadowParam', array($variableName));
						continue 2;
					}
				}
			}
		}

    }//end process()

}//end class


1			<?php
2			/**
3			* PHP 7.1 Forbidden variable names in closure use statements.
4			*
5			* PHP version 7.1
6			*
7			* @category PHP
8			* @package PHPCompatibility
9			* @author Juliette Reinders Folmer <[email protected]>
10			*/
11
12			/**
13			* PHP 7.1 Forbidden variable names in closure use statements.
14			*
15			* Variables bound to a closure via the use construct cannot use the same name
16			* as any superglobals, $this, or any parameter since PHP 7.1.
17			*
18			* PHP version 7.1
19			*
20			* @category PHP
21			* @package PHPCompatibility
22			* @author Juliette Reinders Folmer <[email protected]>
23			*/
24			class PHPCompatibility_Sniffs_PHP_ForbiddenClosureUseVariableNamesSniff extends PHPCompatibility_Sniff
			0 ignored issues – show Coding Style Compatibility introduced 2017-04-03 04:43 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_USE);
35
36			}//end register()
37
38			/**
39			* Processes this test, when one of its tokens is encountered.
40			*
41			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
42			* @param int $stackPtr The position of the current token
43			* in the stack passed in $tokens.
44			*
45			* @return void
46			*/
47			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
48			{
49			if ($this->supportsAbove('7.1') === false) {
50			return;
51			}
52
53			$tokens = $phpcsFile->getTokens();
54
55			// Verify this use statement is used with a closure - if so, it has to have parenthesis before it.
56			$previousNonEmpty = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true, null, true);
57			if ($previousNonEmpty === false \|\| $tokens[$previousNonEmpty]['code'] !== T_CLOSE_PARENTHESIS
58			\|\| isset($tokens[$previousNonEmpty]['parenthesis_opener']) === false
59			) {
60			return;
61			}
62
63			// ... and (a variable within) parenthesis after it.
64			$nextNonEmpty = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true, null, true);
65			if ($nextNonEmpty === false \|\| $tokens[$nextNonEmpty]['code'] !== T_OPEN_PARENTHESIS) {
66			return;
67			}
68
69			if (isset($tokens[$nextNonEmpty]['parenthesis_closer']) === false) {
70			// Live coding.
71			return;
72			}
73
74			$closurePtr = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($tokens[$previousNonEmpty]['parenthesis_opener'] - 1), null, true );
75			if ($tokens[$closurePtr]['code'] !== T_CLOSURE) {
76			return;
77			}
78
79			// Get the parameters declared by the closure.
80			$closureParams = $this->getMethodParameters($phpcsFile, $closurePtr);
			0 ignored issues – show Bug introduced 2017-04-03 04:43 UTC by Report Bug Copy Issue Report It seems like `$closurePtr` defined by `$phpcsFile->findPrevious...ener'] - 1, null, true)` on line `74` can also be of type `boolean`; however, `PHPCompatibility_Sniff::getMethodParameters()` 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...
81
82			$errorMsg = 'Variables bound to a closure via the use construct cannot use the same name as superglobals, $this, or a declared parameter since PHP 7.1. Found: %s';
83
84			for ($i = ($nextNonEmpty + 1); $i < $tokens[$nextNonEmpty]['parenthesis_closer']; $i++) {
85			if ($tokens[$i]['code'] !== T_VARIABLE) {
86			continue;
87			}
88
89			$variableName = $tokens[$i]['content'];
90
91			if ($variableName === '$this') {
92			$phpcsFile->addError($errorMsg, $i, 'FoundThis', array($variableName));
93			continue;
94			}
95
96			if (in_array($variableName, $this->superglobals, true) === true) {
97			$phpcsFile->addError($errorMsg, $i, 'FoundSuperglobal', array($variableName));
98			continue;
99			}
100
101			// Check whether it is one of the parameters declared by the closure.
102			if (empty($closureParams) === false) {
103			foreach ($closureParams as $param) {
104			if ($param['name'] === $variableName) {
105			$phpcsFile->addError($errorMsg, $i, 'FoundShadowParam', array($variableName));
106			continue 2;
107			}
108			}
109			}
110			}
111
112			}//end process()
113
114			}//end class
115

wimg / PHPCompatibility

Pull Request — master (#386)

ForbiddenClosureUseVariableNamesSniff A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like