bkdotcom/PHPDebugConsole

View on GitHub
src/Debug/Plugin/LogRequest.php

Summary

Maintainability
A
25 mins
Test Coverage
A
100%

Function logInput has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    private function logInput($method, $contentType)
    {
        $request = $this->debug->serverRequest;
        $input = StreamUtility::getContents($request->getBody());
        $methodExpectBody = $this->debug->utility->httpMethodHasBody($method);
Severity: Minor
Found in src/Debug/Plugin/LogRequest.php - About 25 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

Define a constant instead of duplicating this literal "redact" 3 times.
Open

            $this->debug->log('php://input', $input, $this->debug->meta('redact'));
Severity: Critical
Found in src/Debug/Plugin/LogRequest.php by sonar-php

Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

Noncompliant Code Example

With the default threshold of 3:

function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

Compliant Solution

ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

Exceptions

To prevent generating some false-positives, literals having less than 5 characters are excluded.

Define a constant instead of duplicating this literal "attribs" 3 times.
Open

                'attribs' => array(
Severity: Critical
Found in src/Debug/Plugin/LogRequest.php by sonar-php

Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

Noncompliant Code Example

With the default threshold of 3:

function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

Compliant Solution

ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

Exceptions

To prevent generating some false-positives, literals having less than 5 characters are excluded.

Replace this function name "logRequest", since a "__construct" method has already been defined in this class.
Open

    public function logRequest()
Severity: Major
Found in src/Debug/Plugin/LogRequest.php by sonar-php

In PHP 4, any function with the same name as the nesting class was considered a class constructor. In PHP 5, this mechanism has been deprecated and the "__construct" method name should be used instead. If both styles are present in the same class, PHP 5 will treat the function named "__construct" as the class constructor.

This rule rule raises an issue for each method with the same name as the enclosing class.

Noncompliant Code Example

class Foo {
  function Foo(){...}
}

Compliant Solution

class Foo {
  function __construct(){...}
}

There are no issues that match your filters.

Category
Status