qcubed/framework

View on GitHub
includes/codegen/QConvertNotationBase.class.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function WordsFromCamelCase has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

        public static function WordsFromCamelCase($strName) {
            if (strlen($strName) == 0)
                return '';

            $strToReturn = QString::FirstCharacter($strName);
Severity: Minor
Found in includes/codegen/QConvertNotationBase.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

Avoid too many return statements within this method.
Open

                    return "str";
Severity: Major
Found in includes/codegen/QConvertNotationBase.class.php - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

                return "";
    Severity: Major
    Found in includes/codegen/QConvertNotationBase.class.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                          return "obj";
      Severity: Major
      Found in includes/codegen/QConvertNotationBase.class.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                            return "int";
        Severity: Major
        Found in includes/codegen/QConvertNotationBase.class.php - About 30 mins to fix

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

                  public static function WordsFromCamelCase($strName) {
                      if (strlen($strName) == 0)
                          return '';
          
                      $strToReturn = QString::FirstCharacter($strName);

          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

          Avoid using static access to class 'QString' in method 'UnderscoreFromCamelCase'.
          Open

                      $strToReturn = QString::FirstCharacter($strName);

          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 CamelCaseFromUnderscore uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
          Open

                          } else {
                              $strToReturn .= substr($strName, 0, $intPosition);
                              $strName = substr($strName, $intPosition + 1);
                          }

          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 'QConvertNotation' in method 'JavaCaseFromUnderscore'.
          Open

                      $strToReturn = QConvertNotation::CamelCaseFromUnderscore($strName);

          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

          Avoid using static access to class 'QString' in method 'WordsFromCamelCase'.
          Open

                      $strToReturn = QString::FirstCharacter($strName);

          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 JavaCaseFromUnderscore is not named in camelCase.
          Open

                  public static function JavaCaseFromUnderscore($strName) {
                      $strToReturn = QConvertNotation::CamelCaseFromUnderscore($strName);
                      return strtolower(substr($strToReturn, 0, 1)) . substr($strToReturn, 1);
                  }

          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 UnderscoreFromCamelCase is not named in camelCase.
          Open

                  public static function UnderscoreFromCamelCase($strName) {
                      if (strlen($strName) == 0)
                          return '';
          
                      $strToReturn = QString::FirstCharacter($strName);

          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 PrefixFromType is not named in camelCase.
          Open

                  public static function PrefixFromType($strType) {
                      switch ($strType) {
                          case QType::ArrayType:
                              return "obj";
                          case QType::Boolean:

          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 CamelCaseFromUnderscore is not named in camelCase.
          Open

                  public static function CamelCaseFromUnderscore($strName) {
                      $strToReturn = '';
          
                      // If entire underscore string is all uppercase, force to all lowercase
                      // (mixed case and all lowercase can remain as is)

          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 WordsFromUnderscore is not named in camelCase.
          Open

                  public static function WordsFromUnderscore($strName) {
                      $strToReturn = trim(str_replace('_', ' ', $strName));
                      if (strtolower($strToReturn) == $strToReturn)
                          return ucwords($strToReturn);
                      return $strToReturn;

          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 WordsFromCamelCase is not named in camelCase.
          Open

                  public static function WordsFromCamelCase($strName) {
                      if (strlen($strName) == 0)
                          return '';
          
                      $strToReturn = QString::FirstCharacter($strName);

          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