Asymptix/Framework

View on GitHub
classes/db/tools/ErrorLog.php

Summary

Maintainability
C
1 day
Test Coverage

log accesses the super-global variable $_SERVER.
Open

    public static function log($type, $called, $script, $line, $message) {
        if (is_null($called)) {
            $called = $_SERVER['SCRIPT_NAME'];
        }

Severity: Minor
Found in classes/db/tools/ErrorLog.php by phpmd

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

Method friendlyErrorType has 33 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function friendlyErrorType($type) {
        switch($type) {
            case E_ERROR: // 1
                return 'E_ERROR';
            case E_WARNING: // 2
Severity: Minor
Found in classes/db/tools/ErrorLog.php - About 1 hr to fix

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

        public static function log($type, $called, $script, $line, $message) {
            if (is_null($called)) {
                $called = $_SERVER['SCRIPT_NAME'];
            }
    
    
    Severity: Minor
    Found in classes/db/tools/ErrorLog.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

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

        public static function log($type, $called, $script, $line, $message) {
    Severity: Minor
    Found in classes/db/tools/ErrorLog.php - About 35 mins to fix

      Avoid too many return statements within this method.
      Open

                      return 'E_CORE_WARNING';
      Severity: Major
      Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                        return 'E_STRICT';
        Severity: Major
        Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                  return "";
          Severity: Major
          Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                            return 'E_DEPRECATED';
            Severity: Major
            Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return 'E_USER_NOTICE';
              Severity: Major
              Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return 'E_USER_DEPRECATED';
                Severity: Major
                Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return 'E_CORE_ERROR';
                  Severity: Major
                  Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                    return 'E_COMPILE_ERROR';
                    Severity: Major
                    Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                      return 'E_COMPILE_WARNING';
                      Severity: Major
                      Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                        return 'E_USER_ERROR';
                        Severity: Major
                        Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                          return 'E_RECOVERABLE_ERROR';
                          Severity: Major
                          Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                            return 'E_USER_WARNING';
                            Severity: Major
                            Found in classes/db/tools/ErrorLog.php - About 30 mins to fix

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

                                  private static function friendlyErrorType($type) {
                                      switch($type) {
                                          case E_ERROR: // 1
                                              return 'E_ERROR';
                                          case E_WARNING: // 2
                              Severity: Minor
                              Found in classes/db/tools/ErrorLog.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

                              Avoid using static access to class '\Asymptix\db\DBCore' in method 'log'.
                              Open

                                          return DBCore::doUpdateQuery($query, "isssisss", array(
                                              $type, implode(", ", $errorTypes), $called, $script, $line, $message, date("Y-m-d H:i:s"), date("Y-m-d H:i:s")
                                          ));
                              Severity: Minor
                              Found in classes/db/tools/ErrorLog.php by phpmd

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

                                      } else {
                                          for ($i = 0; $i < 15;  $i++) {
                                              $errorType = self::friendlyErrorType($type & pow(2, $i));
                                              if (!empty($errorType)) {
                                                  $errorTypes[] = $errorType;
                              Severity: Minor
                              Found in classes/db/tools/ErrorLog.php by phpmd

                              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

                              There are no issues that match your filters.

                              Category
                              Status