njuhel/php-swagger-to-md

View on GitHub
src/SwaggerValidator/Object/ParameterBody.php

Summary

Maintainability
B
5 hrs
Test Coverage

Function markdown has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    public function markdown(\SwaggerValidator\Common\Context $context)
    {
        $method               = __FUNCTION__;
        $schemaKey            = \SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA;
        $templateVars         = array();
Severity: Minor
Found in src/SwaggerValidator/Object/ParameterBody.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

Method markdown has 58 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function markdown(\SwaggerValidator\Common\Context $context)
    {
        $method               = __FUNCTION__;
        $schemaKey            = \SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA;
        $templateVars         = array();
Severity: Major
Found in src/SwaggerValidator/Object/ParameterBody.php - About 2 hrs to fix

    The method markdown() has an NPath complexity of 810. The configured NPath complexity threshold is 200.
    Open

        public function markdown(\SwaggerValidator\Common\Context $context)
        {
            $method               = __FUNCTION__;
            $schemaKey            = \SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA;
            $templateVars         = array();

    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 markdown() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10.
    Open

        public function markdown(\SwaggerValidator\Common\Context $context)
        {
            $method               = __FUNCTION__;
            $schemaKey            = \SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA;
            $templateVars         = array();

    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 markdown uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            else {
                $ref  = \Swagger2md\Swagger2md::makeAnchor(uniqid('objectProperty_'));
                $name = 'parameters/body';
    
                $templateVars['partType']        = \Swagger2md\Swagger2md::getInstance()->renderTemplate('PartTypeFormat', $templateVars);

    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 '\Swagger2md\Swagger2md' in method 'markdown'.
    Open

                $ref  = \Swagger2md\Swagger2md::makeAnchor(uniqid('objectProperty_'));

    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 markdown uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            else {
                $templateVars['type'] = $this->$schemaKey->type;
            }

    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

    There are no issues that match your filters.

    Category
    Status