abrain/einsatzverwaltung

View on GitHub
src/Util/Formatter.php

Summary

Maintainability
D
2 days
Test Coverage
F
4%

File Formatter.php has 437 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
namespace abrain\Einsatzverwaltung\Util;

use abrain\Einsatzverwaltung\Frontend\AnnotationIconBar;
use abrain\Einsatzverwaltung\Model\IncidentReport;
Severity: Minor
Found in src/Util/Formatter.php - About 6 hrs to fix

    Function format has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
    Open

        private function format(?WP_Post $post, string $pattern, string $tag, $context = 'post'): string
        {
            if ($post == null && !in_array($tag, $this->tagsNotNeedingPost)) {
                return $pattern;
            }
    Severity: Minor
    Found in src/Util/Formatter.php - About 4 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 format has 102 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function format(?WP_Post $post, string $pattern, string $tag, $context = 'post'): string
        {
            if ($post == null && !in_array($tag, $this->tagsNotNeedingPost)) {
                return $pattern;
            }
    Severity: Major
    Found in src/Util/Formatter.php - About 4 hrs to fix

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

      class Formatter
      {
          private $tagsNotNeedingPost = array('%feedUrl%', '%yearArchive%');
      
          /**
      Severity: Minor
      Found in src/Util/Formatter.php by phpmd

      Method getVehiclesByUnitString has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function getVehiclesByUnitString(array $vehiclesByUnitId): string
          {
              if (empty($vehiclesByUnitId)) {
                  return '';
              }
      Severity: Minor
      Found in src/Util/Formatter.php - About 1 hr to fix

        Function getTypesOfAlerting has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            public function getTypesOfAlerting(IncidentReport $report, bool $makeLinks): string
            {
                if (empty($report)) {
                    return '';
                }
        Severity: Minor
        Found in src/Util/Formatter.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 getTypesOfAlerting has 27 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function getTypesOfAlerting(IncidentReport $report, bool $makeLinks): string
            {
                if (empty($report)) {
                    return '';
                }
        Severity: Minor
        Found in src/Util/Formatter.php - About 1 hr to fix

          Function getAdditionalForces has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              public function getAdditionalForces(IncidentReport $report, bool $makeLinks, bool $showArchiveLinks): string
              {
                  if (empty($report)) {
                      return '';
                  }
          Severity: Minor
          Found in src/Util/Formatter.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

          Function getVehiclesByUnitString has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              public function getVehiclesByUnitString(array $vehiclesByUnitId): string
              {
                  if (empty($vehiclesByUnitId)) {
                      return '';
                  }
          Severity: Minor
          Found in src/Util/Formatter.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

          Function getVehicleString has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              public function getVehicleString(array $vehicles, bool $makeLinks, bool $showArchiveLinks): string
              {
                  if (empty($vehicles)) {
                      return '';
                  }
          Severity: Minor
          Found in src/Util/Formatter.php - About 35 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 format() has 110 lines of code. Current threshold is set to 100. Avoid really long methods.
          Open

              private function format(?WP_Post $post, string $pattern, string $tag, $context = 'post'): string
              {
                  if ($post == null && !in_array($tag, $this->tagsNotNeedingPost)) {
                      return $pattern;
                  }
          Severity: Minor
          Found in src/Util/Formatter.php by phpmd

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

              private function format(?WP_Post $post, string $pattern, string $tag, $context = 'post'): string
              {
                  if ($post == null && !in_array($tag, $this->tagsNotNeedingPost)) {
                      return $pattern;
                  }
          Severity: Minor
          Found in src/Util/Formatter.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