FopenModeSniff::processParameters() - Code Metrics - Inspection of "New sniff to detect new modes available to fopen()" - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#658)

by Juliette

created 2018-06-11 02:34 UTC

FopenModeSniff::processParameters() C

↳ Parent: FopenModeSniff

Complexity

Conditions	12
Paths	25

Size

Total Lines	51
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	51
rs	5.6668
cc	12
eloc	32
nc	25
nop	4

How to fix Long Method Complexity

<?php
/**
 * \PHPCompatibility\Sniffs\FunctionParameters\FopenModeSniff.
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */

namespace PHPCompatibility\Sniffs\FunctionParameters;

use PHPCompatibility\AbstractFunctionCallParameterSniff;

/**
 * \PHPCompatibility\Sniffs\FunctionParameters\FopenModeSniff.
 *
 * Detect: Changes in allowed values for the fopen() $mode parameter.
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */
class FopenModeSniff extends AbstractFunctionCallParameterSniff
{

    /**
     * Functions to check for.
     *
     * @var array
     */
    protected $targetFunctions = array(
        'fopen' => true,
    );


    /**
     * Do a version check to determine if this sniff needs to run at all.
     *
     * @return bool
     */
    protected function bowOutEarly()
    {
        // Version used here should be (above) the highest version from the `$newModes` array,
        // i.e. the last PHP version in which a new mode was introduced.
        return ($this->supportsBelow('7.1') === false);
    }


    /**
     * Process the parameters of a matched function.
     *
     * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
     * @param int                   $stackPtr     The position of the current token in the stack.
     * @param string                $functionName The token content (function name) which was matched.
     * @param array                 $parameters   Array with information about the parameters.
     *
     * @return int|void Integer stack pointer to skip forward or void to continue
     *                  normal file processing.
     */
    public function processParameters(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $parameters)
    {
        if (isset($parameters[2]) === false) {
            return;
        }

        $tokens      = $phpcsFile->getTokens();
        $targetParam = $parameters[2];
        $errors      = array();

        for ($i = $targetParam['start']; $i <= $targetParam['end']; $i++) {
            if ($tokens[$i]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
                continue;
            }

            if (strpos($tokens[$i]['content'], 'c+') !== false && $this->supportsBelow('5.2.5')) {
                $errors['cplusFound'] = array(
                    'c+',
                    '5.2.5',
                    $targetParam['raw'],
                );
            } elseif (strpos($tokens[$i]['content'], 'c') !== false && $this->supportsBelow('5.2.5')) {
                $errors['cFound'] = array(
                    'c',
                    '5.2.5',
                    $targetParam['raw'],
                );
            }

            if (strpos($tokens[$i]['content'], 'e') !== false && $this->supportsBelow('7.0.15')) {
                $errors['eFound'] = array(
                    'e',
                    '7.0.15',
                    $targetParam['raw'],
                );
            }
        }

        if (empty($errors) === true) {
            return;
        }

        foreach ($errors as $errorCode => $errorData) {
            $phpcsFile->addError(
                'Passing "%s" as the $mode to fopen() is not supported in PHP %s or lower. Found %s',
                $targetParam['start'],
                $errorCode,
                $errorData
            );
        }
    }
}//end class


1			<?php
2			/**
3			* \PHPCompatibility\Sniffs\FunctionParameters\FopenModeSniff.
4			*
5			* @category PHP
6			* @package PHPCompatibility
7			* @author Juliette Reinders Folmer <[email protected]>
8			*/
9
10			namespace PHPCompatibility\Sniffs\FunctionParameters;
11
12			use PHPCompatibility\AbstractFunctionCallParameterSniff;
13
14			/**
15			* \PHPCompatibility\Sniffs\FunctionParameters\FopenModeSniff.
16			*
17			* Detect: Changes in allowed values for the fopen() $mode parameter.
18			*
19			* @category PHP
20			* @package PHPCompatibility
21			* @author Juliette Reinders Folmer <[email protected]>
22			*/
23			class FopenModeSniff extends AbstractFunctionCallParameterSniff
24			{
25
26			/**
27			* Functions to check for.
28			*
29			* @var array
30			*/
31			protected $targetFunctions = array(
32			'fopen' => true,
33			);
34
35
36			/**
37			* Do a version check to determine if this sniff needs to run at all.
38			*
39			* @return bool
40			*/
41			protected function bowOutEarly()
42			{
43			// Version used here should be (above) the highest version from the `$newModes` array,
44			// i.e. the last PHP version in which a new mode was introduced.
45			return ($this->supportsBelow('7.1') === false);
46			}
47
48
49			/**
50			* Process the parameters of a matched function.
51			*
52			* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
53			* @param int $stackPtr The position of the current token in the stack.
54			* @param string $functionName The token content (function name) which was matched.
55			* @param array $parameters Array with information about the parameters.
56			*
57			* @return int\|void Integer stack pointer to skip forward or void to continue
58			* normal file processing.
59			*/
60			public function processParameters(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionName, $parameters)
61			{
62			if (isset($parameters[2]) === false) {
63			return;
64			}
65
66			$tokens = $phpcsFile->getTokens();
67			$targetParam = $parameters[2];
68			$errors = array();
69
70			for ($i = $targetParam['start']; $i <= $targetParam['end']; $i++) {
71			if ($tokens[$i]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
72			continue;
73			}
74
75			if (strpos($tokens[$i]['content'], 'c+') !== false && $this->supportsBelow('5.2.5')) {
76			$errors['cplusFound'] = array(
77			'c+',
78			'5.2.5',
79			$targetParam['raw'],
80			);
81			} elseif (strpos($tokens[$i]['content'], 'c') !== false && $this->supportsBelow('5.2.5')) {
82			$errors['cFound'] = array(
83			'c',
84			'5.2.5',
85			$targetParam['raw'],
86			);
87			}
88
89			if (strpos($tokens[$i]['content'], 'e') !== false && $this->supportsBelow('7.0.15')) {
90			$errors['eFound'] = array(
91			'e',
92			'7.0.15',
93			$targetParam['raw'],
94			);
95			}
96			}
97
98			if (empty($errors) === true) {
99			return;
100			}
101
102			foreach ($errors as $errorCode => $errorData) {
103			$phpcsFile->addError(
104			'Passing "%s" as the $mode to fopen() is not supported in PHP %s or lower. Found %s',
105			$targetParam['start'],
106			$errorCode,
107			$errorData
108			);
109			}
110			}
111			}//end class
112

wimg / PHPCompatibility

Pull Request — master (#658)

FopenModeSniff::processParameters() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like