gdbots/query-parser-php

View on GitHub
src/Builder/XmlQueryBuilder.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function printSimpleNode has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

    protected function printSimpleNode(string $rule, Node $node, ?Field $field = null): void
    {
        if ($this->inRange()) {
            $this->printLine(sprintf('<%s>%s</%s>', $node::NODE_TYPE, $node->getValue(), $node::NODE_TYPE));
            return;
Severity: Minor
Found in src/Builder/XmlQueryBuilder.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 printSimpleNode has 47 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function printSimpleNode(string $rule, Node $node, ?Field $field = null): void
    {
        if ($this->inRange()) {
            $this->printLine(sprintf('<%s>%s</%s>', $node::NODE_TYPE, $node->getValue(), $node::NODE_TYPE));
            return;
Severity: Minor
Found in src/Builder/XmlQueryBuilder.php - About 1 hr to fix

    The method printSimpleNode() has an NPath complexity of 384. The configured NPath complexity threshold is 200.
    Open

        protected function printSimpleNode(string $rule, Node $node, ?Field $field = null): void
        {
            if ($this->inRange()) {
                $this->printLine(sprintf('<%s>%s</%s>', $node::NODE_TYPE, $node->getValue(), $node::NODE_TYPE));
                return;
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

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

        protected function printSimpleNode(string $rule, Node $node, ?Field $field = null): void
        {
            if ($this->inRange()) {
                $this->printLine(sprintf('<%s>%s</%s>', $node::NODE_TYPE, $node->getValue(), $node::NODE_TYPE));
                return;
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 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: http://phpmd.org/rules/codesize.txt

    The class XmlQueryBuilder has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
    Open

    class XmlQueryBuilder extends AbstractQueryBuilder
    {
        /** @var string */
        protected $result;
    
    
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 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: http://phpmd.org/rules/design.txt

    The method endField has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation.
    Open

        protected function endField(Field $field, bool $cacheable = false): void
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example:

    class Foo {
          public function bar($flag = true) {
          }
      }

    Source: http://phpmd.org/rules/cleancode.txt

    The method startField has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation.
    Open

        protected function startField(Field $field, bool $cacheable = false): void
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example:

    class Foo {
          public function bar($flag = true) {
          }
      }

    Source: http://phpmd.org/rules/cleancode.txt

    The method printLine has a boolean flag argument $newLine, which is a certain sign of a Single Responsibility Principle violation.
    Open

        protected function printLine(string $line, bool $newLine = true): void
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example:

    class Foo {
          public function bar($flag = true) {
          }
      }

    Source: http://phpmd.org/rules/cleancode.txt

    The method handleRange has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation.
    Open

        protected function handleRange(Range $range, Field $field, bool $cacheable = false): void
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example:

    class Foo {
          public function bar($flag = true) {
          }
      }

    Source: http://phpmd.org/rules/cleancode.txt

    The method mustNotMatchTerm has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation.
    Open

        protected function mustNotMatchTerm(Node $node, ?Field $field = null, bool $cacheable = false): void
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example:

    class Foo {
          public function bar($flag = true) {
          }
      }

    Source: http://phpmd.org/rules/cleancode.txt

    The method mustMatchTerm has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation.
    Open

        protected function mustMatchTerm(Node $node, ?Field $field = null, bool $cacheable = false): void
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example:

    class Foo {
          public function bar($flag = true) {
          }
      }

    Source: http://phpmd.org/rules/cleancode.txt

    The method handleRange uses an else expression. Else is never necessary and you can simplify the code to work without else.
    Open

            } else {
                $this->printLine('<wildcard/>');
            }
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this 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: http://phpmd.org/rules/cleancode.txt

    The method printSimpleNode uses an else expression. Else is never necessary and you can simplify the code to work without else.
    Open

            } else {
                $tag = $node::NODE_TYPE;
                if ($node->useBoost()) {
                    $tag .= sprintf(' boost="%s"', $node->getBoost());
                } elseif ($node->useFuzzy()) {
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this 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: http://phpmd.org/rules/cleancode.txt

    The method handleRange uses an else expression. Else is never necessary and you can simplify the code to work without else.
    Open

            } else {
                $this->printLine('<wildcard/>');
            }
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 1.4.0

    An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this 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: http://phpmd.org/rules/cleancode.txt

    Avoid using static access to class '\Gdbots\Common\Util\StringUtils' in method 'printSimpleNode'.
    Open

            $tag .= sprintf(' rule="%s"', StringUtils::toSnakeFromCamel($rule));
    Severity: Minor
    Found in src/Builder/XmlQueryBuilder.php by phpmd

    Since: PHPMD 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: http://phpmd.org/rules/cleancode.txt

    Line exceeds 120 characters; contains 125 characters
    Open

            return '<?xml version="1.0"?>' . PHP_EOL . '<query>' . PHP_EOL . rtrim((string)$this->result) . PHP_EOL . '</query>';

    There are no issues that match your filters.

    Category
    Status