rbarros/Security

View on GitHub
src/Security/Random/KeyGen.php

Summary

Maintainability
B
4 hrs
Test Coverage

Method getKey has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function getKey($strength = null)
    {
        $self = self::getInstance();
        switch ($strength) {
            case 'decent_pw':
Severity: Minor
Found in src/Security/Random/KeyGen.php - About 1 hr to fix

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

        public static function getKey($strength = null)
        {
            $self = self::getInstance();
            switch ($strength) {
                case 'decent_pw':
    Severity: Minor
    Found in src/Security/Random/KeyGen.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

    Method keyGen has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            $length = 0,
            $useLowerCase = true,
            $useUpperCase = true,
            $useNumbers = true,
            $useSpecial = true,
    Severity: Minor
    Found in src/Security/Random/KeyGen.php - About 45 mins to fix

      Function keyGen has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          private function keyGen(
              $length = 0,
              $useLowerCase = true,
              $useUpperCase = true,
              $useNumbers = true,
      Severity: Minor
      Found in src/Security/Random/KeyGen.php - About 25 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

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

          public static function getKey($strength = null)
          {
              $self = self::getInstance();
              switch ($strength) {
                  case 'decent_pw':
      Severity: Minor
      Found in src/Security/Random/KeyGen.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 keyGen has a boolean flag argument $useHex, which is a certain sign of a Single Responsibility Principle violation.
      Open

              $useHex = false
      Severity: Minor
      Found in src/Security/Random/KeyGen.php by phpmd

      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

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

              $useLowerCase = true,
      Severity: Minor
      Found in src/Security/Random/KeyGen.php by phpmd

      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

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

              $useNumbers = true,
      Severity: Minor
      Found in src/Security/Random/KeyGen.php by phpmd

      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

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

              $useSpecial = true,
      Severity: Minor
      Found in src/Security/Random/KeyGen.php by phpmd

      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

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

              $useUpperCase = true,
      Severity: Minor
      Found in src/Security/Random/KeyGen.php by phpmd

      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 private fields such as '$types'.
      Open

          private $types = array(
               'decent_pw'    => 'Memorable Passwords - Perfect for securing your computer or mobile device, or somewhere brute force is detectable.'
              ,'strong_pw'    => 'Strong Passwords - Robust enough to keep your web hosting account secure.'
              ,'ft_knox_pw'   => 'Fort Knox Passwords - Secure enough for almost anything, like root or administrator passwords.'
              ,'ci_key'       => 'CodeIgniter Encryption Keys - Can be used for any other 256-bit key requirement.'
      Severity: Minor
      Found in src/Security/Random/KeyGen.php by phpmd

      UnusedPrivateField

      Since: 0.2

      Detects when a private field is declared and/or assigned a value, but not used.

      Example

      class Something
      {
          private static $FOO = 2; // Unused
          private $i = 5; // Unused
          private $j = 6;
          public function addOne()
          {
              return $this->j++;
          }
      }

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

      There are no issues that match your filters.

      Category
      Status