qcubed/framework

View on GitHub
includes/framework/QCryptography.legacy.class.php

Summary

Maintainability
B
5 hrs
Test Coverage

Function __construct has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

        public function __construct($strKey = null, $blnBase64 = null, $strCipher = null, $strMode = null,
                                    $strRandomSource = null) {
            if (!function_exists('mcrypt_module_open')) {
                throw new QCryptographyException("PHP cryptography components (libmcrypt module) are not installed");
            }
Severity: Minor
Found in includes/framework/QCryptography.legacy.class.php - About 2 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

Method __construct has 56 lines of code (exceeds 25 allowed). Consider refactoring.
Open

        public function __construct($strKey = null, $blnBase64 = null, $strCipher = null, $strMode = null,
                                    $strRandomSource = null) {
            if (!function_exists('mcrypt_module_open')) {
                throw new QCryptographyException("PHP cryptography components (libmcrypt module) are not installed");
            }
Severity: Major
Found in includes/framework/QCryptography.legacy.class.php - About 2 hrs to fix

    Method __construct has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            public function __construct($strKey = null, $blnBase64 = null, $strCipher = null, $strMode = null,
                                        $strRandomSource = null) {
    Severity: Minor
    Found in includes/framework/QCryptography.legacy.class.php - About 35 mins to fix

      The method __construct() has an NPath complexity of 768. The configured NPath complexity threshold is 200.
      Open

              public function __construct($strKey = null, $blnBase64 = null, $strCipher = null, $strMode = null,
                                          $strRandomSource = null) {
                  if (!function_exists('mcrypt_module_open')) {
                      throw new QCryptographyException("PHP cryptography components (libmcrypt module) are not installed");
                  }

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

              public function __construct($strKey = null, $blnBase64 = null, $strCipher = null, $strMode = null,
                                          $strRandomSource = null) {
                  if (!function_exists('mcrypt_module_open')) {
                      throw new QCryptographyException("PHP cryptography components (libmcrypt module) are not installed");
                  }

      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

      Missing class import via use statement (line '178', column '15').
      Open

                      throw new QCryptographyException('Unable to deinitialize encryption buffer');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '162', column '15').
      Open

                      throw new QCryptographyException('Incorrect Parameters used in LibMcrypt Initialization');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '217', column '15').
      Open

                      throw new QCryptographyException('Unable to deinitialize encryption buffer');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '209', column '15').
      Open

                      throw new QCryptographyException('Invalid Length Header in Decrypted Data');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '255', column '15').
      Open

                      throw new QCallerException('File does not exist: ' . $strFile);

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '237', column '15').
      Open

                      throw new QCallerException('File does not exist: ' . $strFile);

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '115', column '15').
      Open

                      throw new QCryptographyException('Unable to open LibMcrypt Module');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '73', column '15').
      Open

                      throw new QCryptographyException("PHP cryptography components (libmcrypt module) are not installed");

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '195', column '15').
      Open

                      throw new QCryptographyException('Incorrect Parameters used in LibMcrypt Initialization');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                      $this->strMode = $strMode;
                  }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                      } else {
                          srand();
                          $strIv = mcrypt_create_iv($intIvSize, MCRYPT_RAND);
                      }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      The method DecryptFile uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                      throw new QCallerException('File does not exist: ' . $strFile);
                  }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      Avoid using static access to class 'QType' in method '__construct'.
      Open

                          $this->blnBase64 = QType::Cast(self::$Base64, QType::Boolean);

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                      $this->strRandomSource = $strRandomSource;
                  }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                      } else {
                          $this->blnBase64 = QType::Cast($blnBase64, QType::Boolean);
                      }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      Avoid using static access to class 'QType' in method '__construct'.
      Open

                          $this->blnBase64 = QType::Cast($blnBase64, QType::Boolean);

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                      $this->strCipher = $strCipher;
                  }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

      The method EncryptFile uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                  } else {
                      throw new QCallerException('File does not exist: ' . $strFile);
                  }

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($flag) {
                  // one branch
              } else {
                  // another branch
              }
          }
      }

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

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

                  $intBlockSize = mcrypt_enc_get_block_size($this->objMcryptModule);

      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

      TODO found
      Open

               * TODO: there appears to be some /dev/random locking issues on the QCubed development

      The method EncryptFile is not named in camelCase.
      Open

              public function EncryptFile($strFile) {
                  if (file_exists($strFile)) {
                      $strData = file_get_contents($strFile);
      
                      return $this->Encrypt($strData);

      CamelCaseMethodName

      Since: 0.2

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

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method Decrypt is not named in camelCase.
      Open

              public function Decrypt($strEncryptedData) {
                  // Initialize Encryption
                  $intReturnValue = mcrypt_generic_init($this->objMcryptModule, $this->strKey, $this->strIv);
                  if (($intReturnValue === false) || ($intReturnValue < 0)) {
                      throw new QCryptographyException('Incorrect Parameters used in LibMcrypt Initialization');

      CamelCaseMethodName

      Since: 0.2

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

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method DecryptFile is not named in camelCase.
      Open

              public function DecryptFile($strFile) {
                  if (file_exists($strFile)) {
                      $strEncryptedData = file_get_contents($strFile);
      
                      return $this->Decrypt($strEncryptedData);

      CamelCaseMethodName

      Since: 0.2

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

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method Encrypt is not named in camelCase.
      Open

              public function Encrypt($strData) {
                  // Initialize Encryption
                  $intReturnValue = mcrypt_generic_init($this->objMcryptModule, $this->strKey, $this->strIv);
                  if (($intReturnValue === false) || ($intReturnValue < 0)) {
                      throw new QCryptographyException('Incorrect Parameters used in LibMcrypt Initialization');

      CamelCaseMethodName

      Since: 0.2

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

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      There are no issues that match your filters.

      Category
      Status