PHPCompatibility_Sniffs_PHP_NewClosureSniff::process() - Code Metrics - Inspection of "NewClosures sniff: add checking for new features a..." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#389)

by Juliette

created 2017-04-03 07:48 UTC

process() C

↳ Parent: PHPCompatibility_Sniffs_PHP_NewClosureSniff

Complexity

Conditions	11
Paths	40

Size

Total Lines	82
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	82
rs	5.2653
c	0
b	0
f	0
cc	11
eloc	39
nc	40
nop	2

How to fix Long Method Complexity

<?php
/**
 * PHPCompatibility_Sniffs_PHP_NewClosure.
 *
 * PHP version 5.3
 *
 * @category  PHP
 * @package   PHPCompatibility
 * @author    Wim Godden <[email protected]>
 */

/**
 * PHPCompatibility_Sniffs_PHP_NewClosure.
 *
 * Closures are available since PHP 5.3
 *
 * PHP version 5.3
 *
 * @category  PHP
 * @package   PHPCompatibility
 * @author    Wim Godden <[email protected]>
 */
class PHPCompatibility_Sniffs_PHP_NewClosureSniff 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_CLOSURE);

    }//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)
    {
        $tokens = $phpcsFile->getTokens();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($this->supportsBelow('5.2')) {
            $phpcsFile->addError(
                'Closures / anonymous functions are not available in PHP 5.2 or earlier',
                $stackPtr,
                'Found'
            );
        }

        $isStatic = $this->isClosureStatic($phpcsFile, $stackPtr);
        $usesThis = $this->findThisUsageInClosure($phpcsFile, $stackPtr);

        if ($this->supportsBelow('5.3')) {

            /*
             * Closures can only be declared as static since PHP 5.4.
             */
            if ($isStatic === true) {
                $phpcsFile->addError(
                    'Closures / anonymous functions could not be declared as static in PHP 5.3 or earlier',
                    $stackPtr,
                    'StaticFound'
                );
            }

            /*
             * Closures declared within classes only have access to $this since PHP 5.4.
             */
            if ($usesThis !== false) {
                $thisFound = $usesThis;
                do {
                    $phpcsFile->addError(
                        'Closures / anonymous functions did not have access to $this in PHP 5.3 or earlier',
                        $thisFound,
                        'ThisFound'
                    );

                    $thisFound = $this->findThisUsageInClosure($phpcsFile, $stackPtr, ($thisFound + 1));

                } while($thisFound !== false);
            }
        }

        /*
         * Check for correct usage.
         */
        if ($this->supportsAbove('5.4') && $usesThis !== false) {

            $thisFound = $usesThis;

            do {
                /*
                 * Closures only have access to $this if not declared as static.
                 */
                if ($isStatic === true) {
                    $phpcsFile->addError(
                        'Closures / anonymous functions declared as static do not have access to $this',
                        $thisFound,
                        'ThisFoundInStatic'
                    );
                }

                /*
                 * Closures only have access to $this if used within a class context.
                 */
                else if ($this->inClassScope($phpcsFile, $stackPtr, false) === false) {
                    $phpcsFile->addError(
                        'Closures / anonymous functions only have access to $this if used within a class',
                        $thisFound,
                        'ThisFoundOutsideClass'
                    );
                }

                $thisFound = $this->findThisUsageInClosure($phpcsFile, $stackPtr, ($thisFound + 1));

            } while($thisFound !== false);
        }

    }//end process()


    /**
     * Check whether the closure is declared as static.
     *
     * @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 bool
     */
    protected function isClosureStatic(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $tokens    = $phpcsFile->getTokens();
        $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true, null, true);

        return ($prevToken !== false && $tokens[$prevToken]['code'] === T_STATIC);
    }


    /**
     * Check if the code within a closure uses the $this variable.
     *
     * @param PHP_CodeSniffer_File $phpcsFile  The file being scanned.
     * @param int                  $stackPtr   The position of the closure token.
     * @param int                  $startToken Optional. The position within the closure to continue searching from.
     *
     * @return int|false The stackPtr to the first $this usage if found or false if
     *                   $this is not used or usage of $this could not reliably be determined.
     */
    protected function findThisUsageInClosure(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $startToken = null)
    {
        $tokens = $phpcsFile->getTokens();

        if (isset($tokens[$stackPtr]['scope_opener'], $tokens[$stackPtr]['scope_closer']) === false) {
            // Live coding or parse error.
            return false;
        }

        // Make sure the optional $startToken is valid.
        if (isset($startToken) === true && (isset($tokens[$startToken]) === false || $startToken >= $tokens[$stackPtr]['scope_closer'])) {
            return false;
        }

        $start = ($tokens[$stackPtr]['scope_opener'] + 1);
        if (isset($startToken) === true) {
            $start = $startToken;
        }

        return $phpcsFile->findNext(
            T_VARIABLE,
            $start,
            $tokens[$stackPtr]['scope_closer'],
            false,
            '$this'
        );
    }

}//end class


1			<?php
2			/**
3			* PHPCompatibility_Sniffs_PHP_NewClosure.
4			*
5			* PHP version 5.3
6			*
7			* @category PHP
8			* @package PHPCompatibility
9			* @author Wim Godden <[email protected]>
10			*/
11
12			/**
13			* PHPCompatibility_Sniffs_PHP_NewClosure.
14			*
15			* Closures are available since PHP 5.3
16			*
17			* PHP version 5.3
18			*
19			* @category PHP
20			* @package PHPCompatibility
21			* @author Wim Godden <[email protected]>
22			*/
23			class PHPCompatibility_Sniffs_PHP_NewClosureSniff extends PHPCompatibility_Sniff
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-04 22:56 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...
24			{
25			/**
26			* Returns an array of tokens this test wants to listen for.
27			*
28			* @return array
29			*/
30			public function register()
31			{
32			return array(T_CLOSURE);
33
34			}//end register()
35
36			/**
37			* Processes this test, when one of its tokens is encountered.
38			*
39			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
40			* @param int $stackPtr The position of the current token
41			* in the stack passed in $tokens.
42			*
43			* @return void
44			*/
45			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
46			{
47			$tokens = $phpcsFile->getTokens();
			0 ignored issues – show Unused Code introduced 2017-04-03 07:50 UTC by Report Bug Copy Issue Report `$tokens` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
48
49			if ($this->supportsBelow('5.2')) {
50			$phpcsFile->addError(
51			'Closures / anonymous functions are not available in PHP 5.2 or earlier',
52			$stackPtr,
53			'Found'
54			);
55			}
56
57			$isStatic = $this->isClosureStatic($phpcsFile, $stackPtr);
58			$usesThis = $this->findThisUsageInClosure($phpcsFile, $stackPtr);
59
60			if ($this->supportsBelow('5.3')) {
61
62			/*
63			* Closures can only be declared as static since PHP 5.4.
64			*/
65			if ($isStatic === true) {
66			$phpcsFile->addError(
67			'Closures / anonymous functions could not be declared as static in PHP 5.3 or earlier',
68			$stackPtr,
69			'StaticFound'
70			);
71			}
72
73			/*
74			* Closures declared within classes only have access to $this since PHP 5.4.
75			*/
76			if ($usesThis !== false) {
77			$thisFound = $usesThis;
78			do {
79			$phpcsFile->addError(
80			'Closures / anonymous functions did not have access to $this in PHP 5.3 or earlier',
81			$thisFound,
82			'ThisFound'
83			);
84
85			$thisFound = $this->findThisUsageInClosure($phpcsFile, $stackPtr, ($thisFound + 1));
86
87			} while($thisFound !== false);
88			}
89			}
90
91			/*
92			* Check for correct usage.
93			*/
94			if ($this->supportsAbove('5.4') && $usesThis !== false) {
95
96			$thisFound = $usesThis;
97
98			do {
99			/*
100			* Closures only have access to $this if not declared as static.
101			*/
102			if ($isStatic === true) {
103			$phpcsFile->addError(
104			'Closures / anonymous functions declared as static do not have access to $this',
105			$thisFound,
106			'ThisFoundInStatic'
107			);
108			}
109
110			/*
111			* Closures only have access to $this if used within a class context.
112			*/
113			else if ($this->inClassScope($phpcsFile, $stackPtr, false) === false) {
114			$phpcsFile->addError(
115			'Closures / anonymous functions only have access to $this if used within a class',
116			$thisFound,
117			'ThisFoundOutsideClass'
118			);
119			}
120
121			$thisFound = $this->findThisUsageInClosure($phpcsFile, $stackPtr, ($thisFound + 1));
122
123			} while($thisFound !== false);
124			}
125
126			}//end process()
127
128
129			/**
130			* Check whether the closure is declared as static.
131			*
132			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
133			* @param int $stackPtr The position of the current token
134			* in the stack passed in $tokens.
135			*
136			* @return bool
137			*/
138			protected function isClosureStatic(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
139			{
140			$tokens = $phpcsFile->getTokens();
141			$prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true, null, true);
142
143			return ($prevToken !== false && $tokens[$prevToken]['code'] === T_STATIC);
144			}
145
146
147			/**
148			* Check if the code within a closure uses the $this variable.
149			*
150			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
151			* @param int $stackPtr The position of the closure token.
152			* @param int $startToken Optional. The position within the closure to continue searching from.
153			*
154			* @return int\|false The stackPtr to the first $this usage if found or false if
155			* $this is not used or usage of $this could not reliably be determined.
156			*/
157			protected function findThisUsageInClosure(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $startToken = null)
158			{
159			$tokens = $phpcsFile->getTokens();
160
161			if (isset($tokens[$stackPtr]['scope_opener'], $tokens[$stackPtr]['scope_closer']) === false) {
162			// Live coding or parse error.
163			return false;
164			}
165
166			// Make sure the optional $startToken is valid.
167			if (isset($startToken) === true && (isset($tokens[$startToken]) === false \|\| $startToken >= $tokens[$stackPtr]['scope_closer'])) {
168			return false;
169			}
170
171			$start = ($tokens[$stackPtr]['scope_opener'] + 1);
172			if (isset($startToken) === true) {
173			$start = $startToken;
174			}
175
176			return $phpcsFile->findNext(
177			T_VARIABLE,
178			$start,
179			$tokens[$stackPtr]['scope_closer'],
180			false,
181			'$this'
182			);
183			}
184
185			}//end class
186

wimg / PHPCompatibility

Pull Request — master (#389)

process() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like