Sign upLogin

nabbar/SwaggerValidator-PHP

View on GitHub
Star
src/Object/Parameters.php

Summary

Maintainability
A
1 hr
Test Coverage

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

    function getModel(\SwaggerValidator\Common\Context $context, $listParameters)
    {
        foreach ($this->keys() as $key) {
            $model = null;
            $in    = null;
Severity: Minor
Found in src/Object/Parameters.php - About 45 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 validate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function validate(\SwaggerValidator\Common\Context $context)
    {
        if ($context->getType() !== \SwaggerValidator\Common\Context::TYPE_REQUEST) {
            return true;
        }
Severity: Minor
Found in src/Object/Parameters.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

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/Object/Parameters.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 unused local variables such as '$keyRequired'.
Open

        $keyRequired = \SwaggerValidator\Common\FactorySwagger::KEY_REQUIRED;
Severity: Minor
Found in src/Object/Parameters.php by phpmd

UnusedLocalVariable

Since: 0.2

Detects when a local variable is declared and/or assigned, but not used.

Example

class Foo {
    public function doSomething()
    {
        $i = 5; // Unused
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

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

            $in    = null;
Severity: Minor
Found in src/Object/Parameters.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

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/Object/Parameters.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