yiisoft/yii2

View on GitHub
framework/validators/IpValidator.php

Summary

Maintainability
C
1 day
Test Coverage

Function validateSubnet has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
Open

    private function validateSubnet($ip)
    {
        if (!is_string($ip)) {
            return [$this->message, []];
        }
Severity: Minor
Found in framework/validators/IpValidator.php - About 5 hrs 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

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

class IpValidator extends Validator
{
    /**
     * Negation char.
     *
Severity: Minor
Found in framework/validators/IpValidator.php by phpmd

The class IpValidator has 17 fields. Consider redesigning IpValidator to keep the number of fields under 15.
Open

class IpValidator extends Validator
{
    /**
     * Negation char.
     *
Severity: Minor
Found in framework/validators/IpValidator.php by phpmd

TooManyFields

Since: 0.1

Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.

Example

class Person {
   protected $one;
   private $two;
   private $three;
   [... many more fields ...]
}

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

Function init has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    public function init()
    {
        parent::init();

        if (!$this->ipv4 && !$this->ipv6) {
Severity: Minor
Found in framework/validators/IpValidator.php - About 55 mins 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 prepareRanges has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    private function prepareRanges($ranges)
    {
        $result = [];
        foreach ($ranges as $string) {
            list($isRangeNegated, $range) = $this->parseNegatedRange($string);
Severity: Minor
Found in framework/validators/IpValidator.php - About 45 mins 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 [$this->message, []];
Severity: Major
Found in framework/validators/IpValidator.php - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

                    return [$this->ipv4NotAllowed, []];
    Severity: Major
    Found in framework/validators/IpValidator.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

              return $result;
      Severity: Major
      Found in framework/validators/IpValidator.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                            return [$this->wrongCidr, []];
        Severity: Major
        Found in framework/validators/IpValidator.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                          return [$this->ipv6NotAllowed, []];
          Severity: Major
          Found in framework/validators/IpValidator.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                        return [$this->notInRange, []];
            Severity: Major
            Found in framework/validators/IpValidator.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                                  return [$this->wrongCidr, []];
              Severity: Major
              Found in framework/validators/IpValidator.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return [$this->message, []];
                Severity: Major
                Found in framework/validators/IpValidator.php - About 30 mins to fix

                  The method init() has an NPath complexity of 384. The configured NPath complexity threshold is 200.
                  Open

                      public function init()
                      {
                          parent::init();
                  
                          if (!$this->ipv4 && !$this->ipv6) {
                  Severity: Minor
                  Found in framework/validators/IpValidator.php by phpmd

                  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 validateSubnet() has an NPath complexity of 129600. The configured NPath complexity threshold is 200.
                  Open

                      private function validateSubnet($ip)
                      {
                          if (!is_string($ip)) {
                              return [$this->message, []];
                          }
                  Severity: Minor
                  Found in framework/validators/IpValidator.php by phpmd

                  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 validateSubnet() has a Cyclomatic Complexity of 28. The configured cyclomatic complexity threshold is 10.
                  Open

                      private function validateSubnet($ip)
                      {
                          if (!is_string($ip)) {
                              return [$this->message, []];
                          }
                  Severity: Minor
                  Found in framework/validators/IpValidator.php by phpmd

                  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 init() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
                  Open

                      public function init()
                      {
                          parent::init();
                  
                          if (!$this->ipv4 && !$this->ipv6) {
                  Severity: Minor
                  Found in framework/validators/IpValidator.php by phpmd

                  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

                  There are no issues that match your filters.

                  Category
                  Status