gdbots/pbjc-php

View on GitHub
src/Util/XmlUtils.php

Summary

Maintainability
D
1 day
Test Coverage

Function convertDomElementToArray has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
Open

    public static function convertDomElementToArray(\DomElement $element, $checkPrefix = true)
    {
        $prefix = (string)$element->prefix;
        $empty = true;
        $config = [];
Severity: Minor
Found in src/Util/XmlUtils.php - About 3 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

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

class XmlUtils
{
    /**
     * This class should not be instantiated.
     */
Severity: Minor
Found in src/Util/XmlUtils.php by phpmd

Function loadFile has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    public static function loadFile($file, $schemaOrCallable = null)
    {
        $content = @file_get_contents($file);
        if ('' === trim($content)) {
            throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
Severity: Minor
Found in src/Util/XmlUtils.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 loadFile has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function loadFile($file, $schemaOrCallable = null)
    {
        $content = @file_get_contents($file);
        if ('' === trim($content)) {
            throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
Severity: Minor
Found in src/Util/XmlUtils.php - About 1 hr to fix

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

        public static function convertDomElementToArray(\DomElement $element, $checkPrefix = true)
        {
            $prefix = (string)$element->prefix;
            $empty = true;
            $config = [];
    Severity: Minor
    Found in src/Util/XmlUtils.php - About 1 hr to fix

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

          public static function phpize($value)
          {
              $value = (string)$value;
              $lowercaseValue = strtolower($value);
      
      
      Severity: Minor
      Found in src/Util/XmlUtils.php - About 1 hr to fix

        Avoid too many return statements within this method.
        Open

                        return (float)$value;
        Severity: Major
        Found in src/Util/XmlUtils.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                          return hexdec($value);
          Severity: Major
          Found in src/Util/XmlUtils.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                            return $value;
            Severity: Major
            Found in src/Util/XmlUtils.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return bindec($value);
              Severity: Major
              Found in src/Util/XmlUtils.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return '0x' === $value[0] . $value[1] ? hexdec($value) : (float)$value;
                Severity: Major
                Found in src/Util/XmlUtils.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return false;
                  Severity: Major
                  Found in src/Util/XmlUtils.php - About 30 mins to fix

                    The method convertDomElementToArray() has an NPath complexity of 240. The configured NPath complexity threshold is 200.
                    Open

                        public static function convertDomElementToArray(\DomElement $element, $checkPrefix = true)
                        {
                            $prefix = (string)$element->prefix;
                            $empty = true;
                            $config = [];
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    NPathComplexity

                    Since: 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 https://phpmd.org/rules/codesize.html#npathcomplexity

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

                        public static function loadFile($file, $schemaOrCallable = null)
                        {
                            $content = @file_get_contents($file);
                            if ('' === trim($content)) {
                                throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    NPathComplexity

                    Since: 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 https://phpmd.org/rules/codesize.html#npathcomplexity

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

                        public static function phpize($value)
                        {
                            $value = (string)$value;
                            $lowercaseValue = strtolower($value);
                    
                    
                    Severity: Minor
                    Found in src/Util/XmlUtils.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 method loadFile() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
                    Open

                        public static function loadFile($file, $schemaOrCallable = null)
                        {
                            $content = @file_get_contents($file);
                            if ('' === trim($content)) {
                                throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
                    Severity: Minor
                    Found in src/Util/XmlUtils.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 method convertDomElementToArray() has a Cyclomatic Complexity of 16. The configured cyclomatic complexity threshold is 10.
                    Open

                        public static function convertDomElementToArray(\DomElement $element, $checkPrefix = true)
                        {
                            $prefix = (string)$element->prefix;
                            $empty = true;
                            $config = [];
                    Severity: Minor
                    Found in src/Util/XmlUtils.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

                    Missing class import via use statement (line '78', column '27').
                    Open

                                    throw new \InvalidArgumentException('The schemaOrCallable argument has to be a valid path to XSD file or callable.');
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    MissingImport

                    Since: 2.7.0

                    Importing all external classes in a file through use statements makes them clearly visible.

                    Example

                    function make() {
                        return new \stdClass();
                    }

                    Source http://phpmd.org/rules/cleancode.html#MissingImport

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

                        public static function convertDomElementToArray(\DomElement $element, $checkPrefix = true)
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    BooleanArgumentFlag

                    Since: 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 https://phpmd.org/rules/cleancode.html#booleanargumentflag

                    Missing class import via use statement (line '42', column '20').
                    Open

                            $dom = new \DOMDocument();
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    MissingImport

                    Since: 2.7.0

                    Importing all external classes in a file through use statements makes them clearly visible.

                    Example

                    function make() {
                        return new \stdClass();
                    }

                    Source http://phpmd.org/rules/cleancode.html#MissingImport

                    Missing class import via use statement (line '35', column '23').
                    Open

                                throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    MissingImport

                    Since: 2.7.0

                    Importing all external classes in a file through use statements makes them clearly visible.

                    Example

                    function make() {
                        return new \stdClass();
                    }

                    Source http://phpmd.org/rules/cleancode.html#MissingImport

                    Remove error control operator '@' on line 74.
                    Open

                        public static function loadFile($file, $schemaOrCallable = null)
                        {
                            $content = @file_get_contents($file);
                            if ('' === trim($content)) {
                                throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    ErrorControlOperator

                    Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

                    Example

                    function foo($filePath) {
                        $file = @fopen($filPath); // hides exceptions
                        $key = @$array[$notExistingKey]; // assigns null to $key
                    }

                    Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

                    Missing class import via use statement (line '57', column '27').
                    Open

                                    throw new \InvalidArgumentException('Document types are not allowed.');
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    MissingImport

                    Since: 2.7.0

                    Importing all external classes in a file through use statements makes them clearly visible.

                    Example

                    function make() {
                        return new \stdClass();
                    }

                    Source http://phpmd.org/rules/cleancode.html#MissingImport

                    Missing class import via use statement (line '47', column '23').
                    Open

                                throw new \InvalidArgumentException(implode("\n", static::getXmlErrors($internalErrors)));
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    MissingImport

                    Since: 2.7.0

                    Importing all external classes in a file through use statements makes them clearly visible.

                    Example

                    function make() {
                        return new \stdClass();
                    }

                    Source http://phpmd.org/rules/cleancode.html#MissingImport

                    Remove error control operator '@' on line 33.
                    Open

                        public static function loadFile($file, $schemaOrCallable = null)
                        {
                            $content = @file_get_contents($file);
                            if ('' === trim($content)) {
                                throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file));
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    ErrorControlOperator

                    Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

                    Example

                    function foo($filePath) {
                        $file = @fopen($filPath); // hides exceptions
                        $key = @$array[$notExistingKey]; // assigns null to $key
                    }

                    Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

                    Missing class import via use statement (line '86', column '27').
                    Open

                                    throw new \InvalidArgumentException(implode("\n", $messages), 0, $e);
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    MissingImport

                    Since: 2.7.0

                    Importing all external classes in a file through use statements makes them clearly visible.

                    Example

                    function make() {
                        return new \stdClass();
                    }

                    Source http://phpmd.org/rules/cleancode.html#MissingImport

                    The method loadFile uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                    Open

                                } else {
                                    libxml_use_internal_errors($internalErrors);
                    
                                    throw new \InvalidArgumentException('The schemaOrCallable argument has to be a valid path to XSD file or callable.');
                                }
                    Severity: Minor
                    Found in src/Util/XmlUtils.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

                    The method convertDomElementToArray uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                    Open

                                    } else {
                                        $config[$key] = $value;
                                    }
                    Severity: Minor
                    Found in src/Util/XmlUtils.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

                    The method convertDomElementToArray uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                    Open

                                } else {
                                    $config = $value;
                                }
                    Severity: Minor
                    Found in src/Util/XmlUtils.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

                    Avoid variables with short names like $e. Configured minimum length is 3.
                    Open

                                $e = null;
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpmd

                    ShortVariable

                    Since: 0.2

                    Detects when a field, local, or parameter has a very short name.

                    Example

                    class Something {
                        private $q = 15; // VIOLATION - Field
                        public static function main( array $as ) { // VIOLATION - Formal
                            $r = 20 + $this->q; // VIOLATION - Local
                            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                                $r += $this->q;
                            }
                        }
                    }

                    Source https://phpmd.org/rules/naming.html#shortvariable

                    Line exceeds 120 characters; contains 133 characters
                    Open

                                    throw new \InvalidArgumentException('The schemaOrCallable argument has to be a valid path to XSD file or callable.');
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpcodesniffer

                    Opening parenthesis of a multi-line function call must be the last content on the line
                    Open

                                $errors[] = sprintf('[%s %s] %s (in %s - line %d, column %d)',
                    Severity: Minor
                    Found in src/Util/XmlUtils.php by phpcodesniffer

                    There are no issues that match your filters.

                    Category
                    Status