Sign upLogin

skqr/raml

View on GitHub
Star
RamlDoc.php

Summary

Maintainability
A
1 hr
Test Coverage

Function getPathDefinition has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    public function getPathDefinition($path)
    {
        $raml = $this->rawRaml;

        foreach (explode('/', substr($path, 1)) as $part) {
Severity: Minor
Found in RamlDoc.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

Avoid unused local variables such as '$value'.
Open

        foreach ($this->rawRaml as $key => $value) {
Severity: Minor
Found in RamlDoc.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

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

            } else {
                foreach (array_keys($raml) as $key) {
                    if (static::isParameter($key)) {
                        $raml = $raml[$key];
                        break;
Severity: Minor
Found in RamlDoc.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

Each PHP statement must be on a line by itself
Open

            $callback = function($method) { return strtoupper($method); };
Severity: Minor
Found in RamlDoc.php by phpcodesniffer

Expected 1 space after FUNCTION keyword; 0 found
Open

            $callback = function($method) { return strtoupper($method); };
Severity: Minor
Found in RamlDoc.php by phpcodesniffer

Closing brace must be on a line by itself
Open

            $callback = function($method) { return strtoupper($method); };
Severity: Minor
Found in RamlDoc.php by phpcodesniffer

Opening brace must be the last content on the line
Open

            $callback = function($method) { return strtoupper($method); };
Severity: Minor
Found in RamlDoc.php by phpcodesniffer

There are no issues that match your filters.

Category
Status