MbstringReplaceEModifierSniff::process() - Code Metrics - Inspection of "Merge pull request #213 from jrfnl/feature/issue-2..." - jrfnl/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 01d73e...c6357c )

by Juliette

created 2016-09-04 21:03 UTC

MbstringReplaceEModifierSniff::process() C

↳ Parent: MbstringReplaceEModifierSniff

Complexity

Conditions	10
Paths	10

Size

Total Lines	50
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	50
rs	5.7647
cc	10
eloc	23
nc	10
nop	2

How to fix Complexity

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

/**
 * PHPCompatibility_Sniffs_PHP_MbstringReplaceEModifierSniff.
 *
 * @category  PHP
 * @package   PHPCompatibility
 * @author    Juliette Reinders Folmer <[email protected]>
 */
class PHPCompatibility_Sniffs_PHP_MbstringReplaceEModifierSniff extends PHPCompatibility_Sniff
{

    /**
     * Functions to check for.
     *
     * Key is the function name, value the parameter position of the options parameter.
     *
     * @var array
     */
    protected $functions = array(
        'mb_ereg_replace'      => 4,
        'mb_eregi_replace'     => 4,
        'mb_regex_set_options' => 1,
    );


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        return array(T_STRING);
    }//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();
        $functionNameLc = strtolower($tokens[$stackPtr]['content']);

        // Bow out if not one of the functions we're targetting.
        if ( isset($this->functions[$functionNameLc]) === false ) {
            return;
        }

        // Get the options parameter in the function call.
        $optionsParam = $this->getFunctionCallParameter($phpcsFile, $stackPtr, $this->functions[$functionNameLc]);
        if ($optionsParam === false) {
            return;
        }

        $stringToken = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $optionsParam['start'], $optionsParam['end'] + 1);
        if ($stringToken === false) {
            // No string token found in the options parameter, so skip it (e.g. variable passed in).
            return;
        }

        /**
         * Get the content of any string tokens in the options parameter and remove the quotes.
         */
        $options = trim($tokens[$stringToken]['content'], '\'"');
        if ($stringToken !== $optionsParam['end']) {
            while ($stringToken = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $stringToken + 1, $optionsParam['end'] + 1)) {
                if ($tokens[$stringToken]['code'] === T_CONSTANT_ENCAPSED_STRING) {
                    $options .= trim($tokens[$stringToken]['content'], '\'"');
                }
            }
        }

        if (strpos($options, 'e') !== false) {
            $error = 'The Mbstring regex "e" modifier is deprecated since PHP 7.1.';

            // The alternative mb_ereg_replace_callback() function is only available since 5.4.1
            if ($this->supportsBelow('5.4.1') === false) {
                $error .= ' Use mb_ereg_replace_callback() instead (PHP 5.4.1+).';
            }

            $phpcsFile->addError($error, $stackPtr, 'Found');
        }

    }//end process()

}//end class


1			<?php
2			/**
3			* PHPCompatibility_Sniffs_PHP_MbstringReplaceEModifierSniff.
4			*
5			* PHP version 7.1
6			*
7			* @category PHP
8			* @package PHPCompatibility
9			* @author Juliette Reinders Folmer <[email protected]>
10			*/
11
12			/**
13			* PHPCompatibility_Sniffs_PHP_MbstringReplaceEModifierSniff.
14			*
15			* @category PHP
16			* @package PHPCompatibility
17			* @author Juliette Reinders Folmer <[email protected]>
18			*/
19			class PHPCompatibility_Sniffs_PHP_MbstringReplaceEModifierSniff extends PHPCompatibility_Sniff
20			{
21
22			/**
23			* Functions to check for.
24			*
25			* Key is the function name, value the parameter position of the options parameter.
26			*
27			* @var array
28			*/
29			protected $functions = array(
30			'mb_ereg_replace' => 4,
31			'mb_eregi_replace' => 4,
32			'mb_regex_set_options' => 1,
33			);
34
35
36			/**
37			* Returns an array of tokens this test wants to listen for.
38			*
39			* @return array
40			*/
41			public function register()
42			{
43			return array(T_STRING);
44			}//end register()
45
46
47			/**
48			* Processes this test, when one of its tokens is encountered.
49			*
50			* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
51			* @param int $stackPtr The position of the current token in the
52			* stack passed in $tokens.
53			*
54			* @return void
55			*/
56			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
57			{
58			if ($this->supportsAbove('7.1') === false) {
59			return;
60			}
61
62			$tokens = $phpcsFile->getTokens();
63			$functionNameLc = strtolower($tokens[$stackPtr]['content']);
64
65			// Bow out if not one of the functions we're targetting.
66			if ( isset($this->functions[$functionNameLc]) === false ) {
67			return;
68			}
69
70			// Get the options parameter in the function call.
71			$optionsParam = $this->getFunctionCallParameter($phpcsFile, $stackPtr, $this->functions[$functionNameLc]);
72			if ($optionsParam === false) {
73			return;
74			}
75
76			$stringToken = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $optionsParam['start'], $optionsParam['end'] + 1);
77			if ($stringToken === false) {
78			// No string token found in the options parameter, so skip it (e.g. variable passed in).
79			return;
80			}
81
82			/**
83			* Get the content of any string tokens in the options parameter and remove the quotes.
84			*/
85			$options = trim($tokens[$stringToken]['content'], '\'"');
86			if ($stringToken !== $optionsParam['end']) {
87			while ($stringToken = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $stringToken + 1, $optionsParam['end'] + 1)) {
88			if ($tokens[$stringToken]['code'] === T_CONSTANT_ENCAPSED_STRING) {
89			$options .= trim($tokens[$stringToken]['content'], '\'"');
90			}
91			}
92			}
93
94			if (strpos($options, 'e') !== false) {
95			$error = 'The Mbstring regex "e" modifier is deprecated since PHP 7.1.';
96
97			// The alternative mb_ereg_replace_callback() function is only available since 5.4.1
98			if ($this->supportsBelow('5.4.1') === false) {
99			$error .= ' Use mb_ereg_replace_callback() instead (PHP 5.4.1+).';
100			}
101
102			$phpcsFile->addError($error, $stackPtr, 'Found');
103			}
104
105			}//end process()
106
107			}//end class
108

jrfnl / PHPCompatibility

Push — master ( 01d73e...c6357c )

MbstringReplaceEModifierSniff::process() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like