ForbiddenBreakContinueOutsideLoopSniff::process() - Code Metrics - Inspection of "Add new `ForbiddenBreakContinueOutsideLoop` sniff." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#278)

by Juliette

created 2016-10-17 01:52 UTC

ForbiddenBreakContinueOutsideLoopSniff::process() C

↳ Parent: ForbiddenBreakContinueOutsideLoopSniff

Complexity

Conditions	8
Paths	10

Size

Total Lines	38
Code Lines	21

Duplication

Lines	5
Ratio	13.16 %

Importance

Changes

Metric	Value
dl	5
loc	38
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	21
nc	10
nop	2

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

/**
 * PHPCompatibility_Sniffs_PHP_ForbiddenBreakContinueOutsideLoop.
 *
 * Forbids use of break or continue statements outside of looping structures.
 *
 * PHP version 7
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */
class PHPCompatibility_Sniffs_PHP_ForbiddenBreakContinueOutsideLoopSniff extends PHPCompatibility_Sniff
namespace YourVendor;

class YourClass { }
{

    /**
     * Token codes of control structure in which usage of break/continue is valid.
     *
     * @var array
     */
    protected $validLoopStructures = array(
        T_FOR     => true,
        T_FOREACH => true,
        T_WHILE   => true,
        T_DO      => true,
        T_SWITCH  => true,
    );

    /**
     * Token codes which did not correctly get a condition assigned in older PHPCS versions.
     *
     * @var array
     */
    protected $backCompat = array(
        T_CASE    => true,
        T_DEFAULT => true,
    );

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

    }//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();
        $token  = $tokens[$stackPtr];

        // Check if the break/continue is within a valid loop structure.
        if (empty($token['conditions']) === false) {
            foreach ($token['conditions'] as $tokenCode) {
                if (isset($this->validLoopStructures[$tokenCode]) === true) {
                    return;
                }
            }
        }
        else {
            // Deal with older PHPCS versions.
            if (isset($token['scope_condition']) === true && isset($this->backCompat[$tokens[$token['scope_condition']]['code']]) === true) {
                return;
            }
        }

        // If we're still here, no valid loop structure container has been found, so throw an error.
        $error   = "Using '%s' outside of a loop or switch structure is invalid";
        $isError = false;
        $data    = array(
            $token['content'],
        );
        if ($this->supportsAbove('7.0')) {
            $isError = true;
            $error  .= ' and will throw a fatal error since PHP 7.0';
        }

        if ($isError === true) {

            $phpcsFile->addError($error, $stackPtr, 'Found', $data);
        } else {
            $phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
        }

    }//end process()

}//end class


1		<?php
2		/**
3		* PHPCompatibility_Sniffs_PHP_ForbiddenBreakContinueOutsideLoop.
4		*
5		* PHP version 7
6		*
7		* @category PHP
8		* @package PHPCompatibility
9		* @author Juliette Reinders Folmer <[email protected]>
10		*/
11
12		/**
13		* PHPCompatibility_Sniffs_PHP_ForbiddenBreakContinueOutsideLoop.
14		*
15		* Forbids use of break or continue statements outside of looping structures.
16		*
17		* PHP version 7
18		*
19		* @category PHP
20		* @package PHPCompatibility
21		* @author Juliette Reinders Folmer <[email protected]>
22		*/
23		class PHPCompatibility_Sniffs_PHP_ForbiddenBreakContinueOutsideLoopSniff extends PHPCompatibility_Sniff
		0 ignored issues – show Coding Style Compatibility introduced 2016-10-17 01:54 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		/**
27		* Token codes of control structure in which usage of break/continue is valid.
28		*
29		* @var array
30		*/
31		protected $validLoopStructures = array(
32		T_FOR => true,
33		T_FOREACH => true,
34		T_WHILE => true,
35		T_DO => true,
36		T_SWITCH => true,
37		);
38
39		/**
40		* Token codes which did not correctly get a condition assigned in older PHPCS versions.
41		*
42		* @var array
43		*/
44		protected $backCompat = array(
45		T_CASE => true,
46		T_DEFAULT => true,
47		);
48
49		/**
50		* Returns an array of tokens this test wants to listen for.
51		*
52		* @return array
53		*/
54		public function register()
55		{
56		return array(
57		T_BREAK,
58		T_CONTINUE,
59		);
60
61		}//end register()
62
63		/**
64		* Processes this test, when one of its tokens is encountered.
65		*
66		* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
67		* @param int $stackPtr The position of the current token in the
68		* stack passed in $tokens.
69		*
70		* @return void
71		*/
72		public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
73		{
74		$tokens = $phpcsFile->getTokens();
75		$token = $tokens[$stackPtr];
76
77		// Check if the break/continue is within a valid loop structure.
78		if (empty($token['conditions']) === false) {
79		foreach ($token['conditions'] as $tokenCode) {
80		if (isset($this->validLoopStructures[$tokenCode]) === true) {
81		return;
82		}
83		}
84		}
85		else {
86		// Deal with older PHPCS versions.
87		if (isset($token['scope_condition']) === true && isset($this->backCompat[$tokens[$token['scope_condition']]['code']]) === true) {
88		return;
89		}
90		}
91
92		// If we're still here, no valid loop structure container has been found, so throw an error.
93		$error = "Using '%s' outside of a loop or switch structure is invalid";
94		$isError = false;
95		$data = array(
96		$token['content'],
97		);
98		if ($this->supportsAbove('7.0')) {
99		$isError = true;
100		$error .= ' and will throw a fatal error since PHP 7.0';
101		}
102
103	View Code Duplication	if ($isError === true) {
		1 ignored issue – show Duplication introduced 2016-10-17 01:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		$phpcsFile->addError($error, $stackPtr, 'Found', $data);
105		} else {
106		$phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
107		}
108
109		}//end process()
110
111		}//end class
112

wimg / PHPCompatibility

Pull Request — master (#278)

ForbiddenBreakContinueOutsideLoopSniff::process() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like