DocExpander.php

Summary

Maintainability
A
3 hrs
Test Coverage

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

    private static function applyAllToTree(
        RamlDoc $ramlDoc, array $item, $itemKey = NULL
    )
    {
        if (
Severity: Minor
Found in DocExpander.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 applyAllToTree has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function applyAllToTree(
        RamlDoc $ramlDoc, array $item, $itemKey = NULL
    )
    {
        if (
Severity: Minor
Found in DocExpander.php - About 1 hr to fix

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

        private static function applyAllToTree(
            RamlDoc $ramlDoc, array $item, $itemKey = NULL
        )
        {
            if (
    Severity: Minor
    Found in DocExpander.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 '120', column '27').
    Open

                    throw new \ErrorException($message);
    Severity: Minor
    Found in DocExpander.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 '96', column '23').
    Open

                throw new \ErrorException($message);
    Severity: Minor
    Found in DocExpander.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

    Avoid using static access to class 'GoIntegro\Raml\RamlDoc' in method 'applyAllToTree'.
    Open

                    (RamlDoc::isValidMethod($key) || RamlDoc::isResource($key))
    Severity: Minor
    Found in DocExpander.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

    Avoid using static access to class 'GoIntegro\Raml\RamlDoc' in method 'applyAllToTree'.
    Open

                RamlDoc::isValidMethod($itemKey)
    Severity: Minor
    Found in DocExpander.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

    Avoid using static access to class 'GoIntegro\Raml\RamlDoc' in method 'applyAllToTree'.
    Open

                    (RamlDoc::isValidMethod($key) || RamlDoc::isResource($key))
    Severity: Minor
    Found in DocExpander.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 applyResourceTypeToNode uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
                $message = sprintf(
                    self::ERROR_UNKNOWN_RESOURCE_TYPE, $typeName
                );
                throw new \ErrorException($message);
    Severity: Minor
    Found in DocExpander.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 using static access to class 'GoIntegro\Raml\RamlDoc' in method 'applyAllToTree'.
    Open

            } elseif (RamlDoc::isResource($itemKey)) {
    Severity: Minor
    Found in DocExpander.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

    Avoid using static access to class 'GoIntegro\Raml\RamlDoc' in method 'applyAllToTree'.
    Open

                        if (RamlDoc::isValidMethod($key)) {
    Severity: Minor
    Found in DocExpander.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 applyTraitsToNode uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                    $message = sprintf(self::ERROR_UNKNOWN_TRAIT, $traitName);
                    throw new \ErrorException($message);
                }
    Severity: Minor
    Found in DocExpander.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

    Multi-line function declarations must define one parameter per line
    Open

            RamlDoc $ramlDoc, array $item, $itemKey = NULL
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL"
    Open

            RamlDoc $ramlDoc, array $item, $itemKey = NULL
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line
    Open

        {
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line
    Open

        {
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Multi-line function declarations must define one parameter per line
    Open

            RamlDoc $ramlDoc, array &$item
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line
    Open

        {
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Multi-line function declarations must define one parameter per line
    Open

            RamlDoc $ramlDoc, array &$item, array $traits
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Multi-line function declarations must define one parameter per line
    Open

            RamlDoc $ramlDoc, array $item, $itemKey = NULL
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Multi-line function declarations must define one parameter per line
    Open

            RamlDoc $ramlDoc, array &$item, array $traits
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Only one argument is allowed per line in a multi-line function call
    Open

                    self::ERROR_UNKNOWN_RESOURCE_TYPE, $typeName
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Only one argument is allowed per line in a multi-line function call
    Open

                    $ramlDoc, $item, $item[RamlSpec::PROPERTY_APPLY_TRAITS]
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Only one argument is allowed per line in a multi-line function call
    Open

                    $ramlDoc, $item, $item[RamlSpec::PROPERTY_APPLY_TRAITS]
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Expected 0 spaces after opening bracket; newline found
    Open

                if (
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    Expected 0 spaces after opening bracket; newline found
    Open

            if (
    Severity: Minor
    Found in DocExpander.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status