martin-helmich/typo3-typoscript-parser

View on GitHub
src/Parser/Printer/PrettyPrinter.php

Summary

Maintainability
A
3 hrs
Test Coverage
A
96%

Method printStatementList has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function printStatementList(array $statements, OutputInterface $output, int $nesting = 0): void
    {
        $indent = $this->getIndent($nesting);
        $count  = count($statements);

Severity: Minor
Found in src/Parser/Printer/PrettyPrinter.php - About 1 hr to fix

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

        private function printStatementList(array $statements, OutputInterface $output, int $nesting = 0): void
        {
            $indent = $this->getIndent($nesting);
            $count  = count($statements);
    
    
    Severity: Minor
    Found in src/Parser/Printer/PrettyPrinter.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 printConditionalStatement has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        private function printConditionalStatement(OutputInterface $output, int $nesting, ConditionalStatement $statement, bool $hasNext = false, bool $hasPrevious = false): void
    Severity: Minor
    Found in src/Parser/Printer/PrettyPrinter.php - About 35 mins to fix

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

          private function printStatementList(array $statements, OutputInterface $output, int $nesting = 0): void
          {
              $indent = $this->getIndent($nesting);
              $count  = count($statements);
      
      
      Severity: Minor
      Found in src/Parser/Printer/PrettyPrinter.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 class PrettyPrinter has a coupling between objects value of 18. Consider to reduce the number of dependencies under 13.
      Open

      class PrettyPrinter implements ASTPrinterInterface
      {
          /**
           * @var PrettyPrinterConfiguration
           */
      Severity: Minor
      Found in src/Parser/Printer/PrettyPrinter.php by phpmd

      CouplingBetweenObjects

      Since: 1.1.0

      A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

      Example

      class Foo {
          /**
           * @var \foo\bar\X
           */
          private $x = null;
      
          /**
           * @var \foo\bar\Y
           */
          private $y = null;
      
          /**
           * @var \foo\bar\Z
           */
          private $z = null;
      
          public function setFoo(\Foo $foo) {}
          public function setBar(\Bar $bar) {}
          public function setBaz(\Baz $baz) {}
      
          /**
           * @return \SplObjectStorage
           * @throws \OutOfRangeException
           * @throws \InvalidArgumentException
           * @throws \ErrorException
           */
          public function process(\Iterator $it) {}
      
          // ...
      }

      Source https://phpmd.org/rules/design.html#couplingbetweenobjects

      Avoid using static access to class 'Helmich\TypoScriptParser\Parser\Printer\PrettyPrinterConfiguration' in method '__construct'.
      Open

              $this->prettyPrinterConfiguration = $prettyPrinterConfiguration ?? PrettyPrinterConfiguration::create();
      Severity: Minor
      Found in src/Parser/Printer/PrettyPrinter.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

      Expected 1 space after IF keyword; 0 found
      Open

              if($this->prettyPrinterConfiguration->shouldIncludeEmptyLineBreaks()) {

      There are no issues that match your filters.

      Category
      Status