Sign upLogin

nabbar/SwaggerValidator-PHP

View on GitHub
Star
src/DataType/TypeObject.php

Summary

Maintainability
D
1 day
Test Coverage

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

    public function validate(\SwaggerValidator\Common\Context $context)
    {
        $keyRequired   = \SwaggerValidator\Common\FactorySwagger::KEY_REQUIRED;
        $keyAdditional = \SwaggerValidator\Common\FactorySwagger::KEY_ADDPROPERTIES;
Severity: Minor
Found in src/DataType/TypeObject.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 TypeObject has an overall complexity of 65 which is very high. The configured complexity threshold is 50.
Open

class TypeObject extends \SwaggerValidator\Common\CollectionSwagger
{

    /**
     *
Severity: Minor
Found in src/DataType/TypeObject.php by phpmd

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

    public function jsonUnSerialize(\SwaggerValidator\Common\Context $context, $jsonData)
    {
        $this->checkJsonObject($context, $jsonData);

        if (property_exists($jsonData, \SwaggerValidator\Common\FactorySwagger::KEY_REFERENCE) && count(get_object_vars($jsonData)) > 1) {
Severity: Minor
Found in src/DataType/TypeObject.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 validate has 50 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function validate(\SwaggerValidator\Common\Context $context)
    {
        $keyRequired   = \SwaggerValidator\Common\FactorySwagger::KEY_REQUIRED;
        $keyAdditional = \SwaggerValidator\Common\FactorySwagger::KEY_ADDPROPERTIES;
Severity: Minor
Found in src/DataType/TypeObject.php - About 2 hrs to fix

    Method jsonUnSerialize has 45 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function jsonUnSerialize(\SwaggerValidator\Common\Context $context, $jsonData)
    {
        $this->checkJsonObject($context, $jsonData);

        if (property_exists($jsonData, \SwaggerValidator\Common\FactorySwagger::KEY_REFERENCE) && count(get_object_vars($jsonData)) > 1) {
    Severity: Minor
    Found in src/DataType/TypeObject.php - About 1 hr to fix

      Function jsonSerialize has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          public function jsonSerialize()
    {
        if (parent::__isset(\SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA)) {
            return parent::jsonSerialize();
        }
      Severity: Minor
      Found in src/DataType/TypeObject.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 jsonSerialize has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function jsonSerialize()
    {
        if (parent::__isset(\SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA)) {
            return parent::jsonSerialize();
        }
      Severity: Minor
      Found in src/DataType/TypeObject.php - About 1 hr to fix

        Function getModel has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            public function getModel(\SwaggerValidator\Common\Context $context)
    {
        $result = new \stdClass();

        foreach ($this->properties as $key) {
        Severity: Minor
        Found in src/DataType/TypeObject.php - About 35 mins 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

        Function unserialize has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            public function unserialize($data)
    {
        if (!is_array($data)) {
            $data = unserialize($data);
        }
        Severity: Minor
        Found in src/DataType/TypeObject.php - About 35 mins 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

        Avoid too many return statements within this method.
        Open

                        return $context->setDataPath($key)->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_TOOMANY, 'Property "' . $key . '" is not awaiting in the value object !', __METHOD__, __LINE__);
        Severity: Major
        Found in src/DataType/TypeObject.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                  return true;
          Severity: Major
          Found in src/DataType/TypeObject.php - About 30 mins to fix

            The method validate() has an NPath complexity of 16352. The configured NPath complexity threshold is 200.
            Open

                public function validate(\SwaggerValidator\Common\Context $context)
    {
        $keyRequired   = \SwaggerValidator\Common\FactorySwagger::KEY_REQUIRED;
        $keyAdditional = \SwaggerValidator\Common\FactorySwagger::KEY_ADDPROPERTIES;
            Severity: Minor
            Found in src/DataType/TypeObject.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 jsonSerialize() has an NPath complexity of 468. The configured NPath complexity threshold is 200.
            Open

                public function jsonSerialize()
    {
        if (parent::__isset(\SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA)) {
            return parent::jsonSerialize();
        }
            Severity: Minor
            Found in src/DataType/TypeObject.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 jsonUnSerialize() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
            Open

                public function jsonUnSerialize(\SwaggerValidator\Common\Context $context, $jsonData)
    {
        $this->checkJsonObject($context, $jsonData);

        if (property_exists($jsonData, \SwaggerValidator\Common\FactorySwagger::KEY_REFERENCE) && count(get_object_vars($jsonData)) > 1) {
            Severity: Minor
            Found in src/DataType/TypeObject.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 validate() has a Cyclomatic Complexity of 20. The configured cyclomatic complexity threshold is 10.
            Open

                public function validate(\SwaggerValidator\Common\Context $context)
    {
        $keyRequired   = \SwaggerValidator\Common\FactorySwagger::KEY_REQUIRED;
        $keyAdditional = \SwaggerValidator\Common\FactorySwagger::KEY_ADDPROPERTIES;
            Severity: Minor
            Found in src/DataType/TypeObject.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 jsonSerialize() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
            Open

                public function jsonSerialize()
    {
        if (parent::__isset(\SwaggerValidator\Common\FactorySwagger::KEY_SCHEMA)) {
            return parent::jsonSerialize();
        }
            Severity: Minor
            Found in src/DataType/TypeObject.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 '187', column '30').
            Open

                    $result        = new \stdClass();
            Severity: Minor
            Found in src/DataType/TypeObject.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 '199', column '40').
            Open

                        $result->$properties = new \stdClass();
            Severity: Minor
            Found in src/DataType/TypeObject.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 '295', column '23').
            Open

                    $result = new \stdClass();
            Severity: Minor
            Found in src/DataType/TypeObject.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 unserialize uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
            Open

                        else {
                $this->$key = $value;
            }
            Severity: Minor
            Found in src/DataType/TypeObject.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 __storeData uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
            Open

                    else {
            parent::__storeData($key, $value);
        }
            Severity: Minor
            Found in src/DataType/TypeObject.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 jsonUnSerialize uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
            Open

                                else {
                        $context->throwException('Invalid properties definition ! ', __METHOD__, __LINE__);
                    }
            Severity: Minor
            Found in src/DataType/TypeObject.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 '\SwaggerValidator\Common\Collection' in method 'jsonSerialize'.
            Open

                            $result->$additional->$key = json_decode(\SwaggerValidator\Common\Collection::jsonEncode($this->$key), false);
            Severity: Minor
            Found in src/DataType/TypeObject.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 getModel uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
            Open

                        else {
                $result->$key = $object;
            }
            Severity: Minor
            Found in src/DataType/TypeObject.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 '\SwaggerValidator\Common\Collection' in method 'jsonSerialize'.
            Open

                            $result->$properties->$key = json_decode(\SwaggerValidator\Common\Collection::jsonEncode($this->$key), false);
            Severity: Minor
            Found in src/DataType/TypeObject.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 '\SwaggerValidator\Common\Collection' in method 'jsonSerialize'.
            Open

                            $result->$key = json_decode(\SwaggerValidator\Common\Collection::jsonEncode($this->$key), false);
            Severity: Minor
            Found in src/DataType/TypeObject.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 __storeData is not named in camelCase.
            Open

                protected function __storeData($key, $value = null)
    {
        if (property_exists($this, $key)) {
            $this->$key = $value;
        }
            Severity: Minor
            Found in src/DataType/TypeObject.php by phpmd

            CamelCaseMethodName

            Since: 0.2

            It is considered best practice to use the camelCase notation to name methods.

            Example

            class ClassName {
    public function get_name() {
    }
}

            Source

            There are no issues that match your filters.

            Category
            Status