PhpCompat - Code Metrics - Inspection of "changed the fix #727" - evolution-cms/evolution - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( e96e2d...4e806c )

by Agel_Nash

created 2018-06-15 21:47 UTC

PhpCompat A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	44
rs	10
c	0
b	0
f	0
wmc	9
lcom	0
cbo	1

2 Methods

Rating	Name	Duplication	Size	Complexity
C	htmlspecialchars()	0	29	8
A	entities()	0	4	1

<?php namespace EvolutionCMS\Legacy;

use EvolutionCMS\Interfaces\PhpCompatInterface;

/**
 * @TODO file_put_contents(), strftime(), mb_*()

 */
class PhpCompat implements PhpCompatInterface
{
    /**
     * @param string|array $str
     * @param int $flags
     * @param string $encode
     * @param int $safecount
     * @return string|array

     */
    public function htmlspecialchars($str = '', $flags = ENT_COMPAT, $encode = '', $safecount = 0)
    {
        $safecount++;
        $modx = evolutionCMS();

        if (1000 < $safecount) {
            exit("error too many loops '{$safecount}'");

        }

        if (is_array($str)) {
            foreach ($str as $i => $v) {
                $str[$i] = $this->htmlspecialchars($v, $flags, $encode, $safecount);
            }
        } elseif ($str !== '') {
            if ($encode !== '') {
                $encode = $modx->config['modx_charset'];
            }
            $ent_str = htmlspecialchars($str, $flags, $encode);

            if (!empty($str) && empty($ent_str)) {
                $detect_order = implode(',', mb_detect_order());
                $ent_str = mb_convert_encoding($str, $encode, $detect_order);
            }
        } else {
            $ent_str = '';
        }

        return $ent_str;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    public function entities($data)
    {
        return entities($data, evolutionCMS()->getConfig('modx_charset', 'UTF-8'));

    }
}


1			<?php namespace EvolutionCMS\Legacy;
2
3			use EvolutionCMS\Interfaces\PhpCompatInterface;
4
5			/**
6			* @TODO file_put_contents(), strftime(), mb_*()
			0 ignored issues – show Coding Style introduced 2018-02-25 17:05 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
7			*/
8			class PhpCompat implements PhpCompatInterface
9			{
10			/**
11			* @param string\|array $str
12			* @param int $flags
13			* @param string $encode
14			* @param int $safecount
15			* @return string\|array
			0 ignored issues – show Documentation introduced 2018-06-07 19:23 UTC by Report Bug Copy Issue Report Should the return type not be `null\|string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
16			*/
17			public function htmlspecialchars($str = '', $flags = ENT_COMPAT, $encode = '', $safecount = 0)
18			{
19			$safecount++;
20			$modx = evolutionCMS();
21
22			if (1000 < $safecount) {
23			exit("error too many loops '{$safecount}'");
			0 ignored issues – show Coding Style Compatibility introduced 2018-06-07 19:23 UTC by Report Bug Copy Issue Report The method `htmlspecialchars()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
24			}
25
26			if (is_array($str)) {
27			foreach ($str as $i => $v) {
28			$str[$i] = $this->htmlspecialchars($v, $flags, $encode, $safecount);
29			}
30			} elseif ($str !== '') {
31			if ($encode !== '') {
32			$encode = $modx->config['modx_charset'];
33			}
34			$ent_str = htmlspecialchars($str, $flags, $encode);
35
36			if (!empty($str) && empty($ent_str)) {
37			$detect_order = implode(',', mb_detect_order());
38			$ent_str = mb_convert_encoding($str, $encode, $detect_order);
39			}
40			} else {
41			$ent_str = '';
42			}
43
44			return $ent_str;
			0 ignored issues – show Bug introduced 2018-06-15 21:53 UTC by Report Bug Copy Issue Report The variable `$ent_str` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
45			}
46
47			public function entities($data)
48			{
49			return entities($data, evolutionCMS()->getConfig('modx_charset', 'UTF-8'));
			0 ignored issues – show Bug introduced 2018-06-15 21:53 UTC by Report Bug Copy Issue Report It seems like `evolutionCMS()->getConfi...modx_charset', 'UTF-8')` targeting `EvolutionCMS\Core::getConfig()` can also be of type `boolean`; however, `entities()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
50			}
51			}
52

evolution-cms / evolution

Push — develop ( e96e2d...4e806c )

PhpCompat A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like