yiisoft/yii2

View on GitHub
framework/requirements/YiiRequirementChecker.php

Summary

Maintainability
C
1 day
Test Coverage

The method evaluateExpression() contains an eval expression.
Open

        return eval('return ' . $expression . ';');

EvalExpression

Since: 0.2

An eval-expression is untestable, a security risk and bad practice. Therefore it should be avoided. Consider to replace the eval-expression with regular code.

Example

class Foo {
    public function bar($param)  {
        if ($param === 42) {
            eval('$param = 23;');
        }
    }
}

Source https://phpmd.org/rules/design.html#evalexpression

getServerInfo accesses the super-global variable $_SERVER.
Open

    function getServerInfo()
    {
        return isset($_SERVER['SERVER_SOFTWARE']) ? $_SERVER['SERVER_SOFTWARE'] : '';
    }

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

render accesses the super-global variable $_SERVER.
Open

    function render()
    {
        if (!isset($this->result)) {
            $this->usageError('Nothing to render!');
        }

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

getServerInfo accesses the super-global variable $_SERVER.
Open

    function getServerInfo()
    {
        return isset($_SERVER['SERVER_SOFTWARE']) ? $_SERVER['SERVER_SOFTWARE'] : '';
    }

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

The class YiiRequirementChecker has 12 public methods. Consider refactoring YiiRequirementChecker to keep number of public methods under 10.
Open

class YiiRequirementChecker
{
    /**
     * Check the given requirements, collecting results into internal field.
     * This method can be invoked several times checking different requirement sets.

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

The class YiiRequirementChecker has an overall complexity of 59 which is very high. The configured complexity threshold is 50.
Open

class YiiRequirementChecker
{
    /**
     * Check the given requirements, collecting results into internal field.
     * This method can be invoked several times checking different requirement sets.

Function normalizeRequirement has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    function normalizeRequirement($requirement, $requirementKey = 0)
    {
        if (!is_array($requirement)) {
            $this->usageError('Requirement must be an array!');
        }
Severity: Minor
Found in framework/requirements/YiiRequirementChecker.php - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function check has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    function check($requirements)
    {
        if (is_string($requirements)) {
            $requirements = require $requirements;
        }
Severity: Minor
Found in framework/requirements/YiiRequirementChecker.php - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid too many return statements within this method.
Open

                return 0;
Severity: Major
Found in framework/requirements/YiiRequirementChecker.php - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

                    return $size * 1024 * 1024 * 1024;
    Severity: Major
    Found in framework/requirements/YiiRequirementChecker.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                      return $size * 1024 * 1024;
      Severity: Major
      Found in framework/requirements/YiiRequirementChecker.php - About 30 mins to fix

        The method normalizeRequirement() has an NPath complexity of 288. The configured NPath complexity threshold is 200.
        Open

            function normalizeRequirement($requirement, $requirementKey = 0)
            {
                if (!is_array($requirement)) {
                    $this->usageError('Requirement must be an array!');
                }

        NPathComplexity

        Since: 0.1

        The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

        Example

        class Foo {
            function bar() {
                // lots of complicated code
            }
        }

        Source https://phpmd.org/rules/codesize.html#npathcomplexity

        The method getByteSize() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
        Open

            function getByteSize($verboseSize)
            {
                if (empty($verboseSize)) {
                    return 0;
                }

        CyclomaticComplexity

        Since: 0.1

        Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

        Example

        // Cyclomatic Complexity = 11
        class Foo {
        1   public function example() {
        2       if ($a == $b) {
        3           if ($a1 == $b1) {
                        fiddle();
        4           } elseif ($a2 == $b2) {
                        fiddle();
                    } else {
                        fiddle();
                    }
        5       } elseif ($c == $d) {
        6           while ($c == $d) {
                        fiddle();
                    }
        7        } elseif ($e == $f) {
        8           for ($n = 0; $n < $h; $n++) {
                        fiddle();
                    }
                } else {
                    switch ($z) {
        9               case 1:
                            fiddle();
                            break;
        10              case 2:
                            fiddle();
                            break;
        11              case 3:
                            fiddle();
                            break;
                        default:
                            fiddle();
                            break;
                    }
                }
            }
        }

        Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

        The method normalizeRequirement() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
        Open

            function normalizeRequirement($requirement, $requirementKey = 0)
            {
                if (!is_array($requirement)) {
                    $this->usageError('Requirement must be an array!');
                }

        CyclomaticComplexity

        Since: 0.1

        Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

        Example

        // Cyclomatic Complexity = 11
        class Foo {
        1   public function example() {
        2       if ($a == $b) {
        3           if ($a1 == $b1) {
                        fiddle();
        4           } elseif ($a2 == $b2) {
                        fiddle();
                    } else {
                        fiddle();
                    }
        5       } elseif ($c == $d) {
        6           while ($c == $d) {
                        fiddle();
                    }
        7        } elseif ($e == $f) {
        8           for ($n = 0; $n < $h; $n++) {
                        fiddle();
                    }
                } else {
                    switch ($z) {
        9               case 1:
                            fiddle();
                            break;
        10              case 2:
                            fiddle();
                            break;
        11              case 3:
                            fiddle();
                            break;
                        default:
                            fiddle();
                            break;
                    }
                }
            }
        }

        Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

        Remove error control operator '@' on line 397.
        Open

            function getNowDate()
            {
                return @strftime('%Y-%m-%d %H:%M', time());
            }

        ErrorControlOperator

        Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

        Example

        function foo($filePath) {
            $file = @fopen($filPath); // hides exceptions
            $key = @$array[$notExistingKey]; // assigns null to $key
        }

        Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

        The method renderViewFile has a boolean flag argument $_return_, which is a certain sign of a Single Responsibility Principle violation.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)

        BooleanArgumentFlag

        Since: 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example

        class Foo {
            public function bar($flag = true) {
            }
        }

        Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

        Avoid unused local variables such as '$data'.
        Open

                    $data = $_data_;

        UnusedLocalVariable

        Since: 0.2

        Detects when a local variable is declared and/or assigned, but not used.

        Example

        class Foo {
            public function doSomething()
            {
                $i = 5; // Unused
            }
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

        The method usageError() contains an exit expression.
        Open

                exit(1);

        ExitExpression

        Since: 0.2

        An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

        Example

        class Foo {
            public function bar($param)  {
                if ($param === 42) {
                    exit(23);
                }
            }
        }

        Source https://phpmd.org/rules/design.html#exitexpression

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

            function getByteSize($verboseSize)
            {
                if (empty($verboseSize)) {
                    return 0;
                }
        Severity: Major
        Found in framework/requirements/YiiRequirementChecker.php and 1 other location - About 4 hrs to fix
        framework/web/MultipartFormDataParser.php on lines 345..371

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 169.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        The parameter $_data_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseParameterName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name parameters.

        Example

        class ClassName {
            public function doSomething($user_name) {
            }
        }

        Source

        The parameter $_viewFile_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseParameterName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name parameters.

        Example

        class ClassName {
            public function doSomething($user_name) {
            }
        }

        Source

        The parameter $_return_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseParameterName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name parameters.

        Example

        class ClassName {
            public function doSomething($user_name) {
            }
        }

        Source

        The variable $_data_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseVariableName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name variables.

        Example

        class ClassName {
            public function doSomething() {
                $data_module = new DataModule();
            }
        }

        Source

        The variable $_data_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseVariableName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name variables.

        Example

        class ClassName {
            public function doSomething() {
                $data_module = new DataModule();
            }
        }

        Source

        The variable $_viewFile_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseVariableName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name variables.

        Example

        class ClassName {
            public function doSomething() {
                $data_module = new DataModule();
            }
        }

        Source

        The variable $_data_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseVariableName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name variables.

        Example

        class ClassName {
            public function doSomething() {
                $data_module = new DataModule();
            }
        }

        Source

        The variable $_viewFile_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseVariableName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name variables.

        Example

        class ClassName {
            public function doSomething() {
                $data_module = new DataModule();
            }
        }

        Source

        The variable $_return_ is not named in camelCase.
        Open

            function renderViewFile($_viewFile_, $_data_ = null, $_return_ = false)
            {
                // we use special variable names here to avoid conflict when extracting data
                if (is_array($_data_)) {
                    extract($_data_, EXTR_PREFIX_SAME, 'data');

        CamelCaseVariableName

        Since: 0.2

        It is considered best practice to use the camelCase notation to name variables.

        Example

        class ClassName {
            public function doSomething() {
                $data_module = new DataModule();
            }
        }

        Source

        There are no issues that match your filters.

        Category
        Status