Sign upLogin

bkdotcom/PHPDebugConsole

View on GitHub
Star
src/Debug/Dump/TextAnsi/Value.php

Summary

Maintainability
A
2 hrs
Test Coverage
A
98%

Value has 22 functions (exceeds 20 allowed). Consider refactoring.
Open

class Value extends TextValue
{
    /** @var string */
    protected $escapeReset = "\e[0m";
Severity: Minor
Found in src/Debug/Dump/TextAnsi/Value.php - About 2 hrs to fix

    Class "Value" has 22 methods, which is greater than 20 authorized. Split it into smaller classes.
    Open

    class Value extends TextValue
    Severity: Major
    Found in src/Debug/Dump/TextAnsi/Value.php by sonar-php

    A class that grows too much tends to aggregate too many responsibilities and inevitably becomes harder to understand and therefore to maintain. Above a specific threshold, it is strongly advised to refactor the class into smaller ones which focus on well defined topics.

    Define a constant instead of duplicating this literal "strlenValue" 4 times.
    Open

            if ($abs['strlenValue'] === null) {
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "\e[22m" 3 times.
    Open

                $identifier = "\e[1m" . $this->highlightChars($parts['name']) . "\e[22m";
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "operator" 3 times.
    Open

            $operator = $this->cfg['escapeCodes']['operator'] . $parts['operator'] . $this->escapeReset;
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "muted" 6 times.
    Open

                ? '📅 ' . $val . ' ' . $this->cfg['escapeCodes']['muted'] . '(' . $date . ')' . $this->escapeReset
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "arrayKey" 3 times.
    Open

            $regexRemoveKeyReset = '/' . \preg_quote($escapeCodes['arrayKey']) . '$/';
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "escapeCodes" 23 times.
    Open

            $operator = $this->cfg['escapeCodes']['operator'] . $parts['operator'] . $this->escapeReset;
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "value" 4 times.
    Open

            return $this->markupIdentifier($abs['value'], $abs['typeMore']);
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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.

    Rename "$escapeReset" which has the same name as the field declared at line 29.
    Open

            $escapeReset = $this->escapeReset;
    Severity: Major
    Found in src/Debug/Dump/TextAnsi/Value.php by sonar-php

    Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.

    Noncompliant Code Example

    class Foo {
  public $myField;

  public function doSomething() {
    $myField = 0;
    ...
  }
}

    See

    Define a constant instead of duplicating this literal "punct" 4 times.
    Open

            $str = $escapeCodes['keyword'] . 'array' . $escapeCodes['punct'] . '(' . $this->escapeReset . "\n"
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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.

    Rename "$escapeReset" which has the same name as the field declared at line 29.
    Open

            $escapeReset = $this->escapeReset;
    Severity: Major
    Found in src/Debug/Dump/TextAnsi/Value.php by sonar-php

    Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.

    Noncompliant Code Example

    class Foo {
  public $myField;

  public function doSomething() {
    $myField = 0;
    ...
  }
}

    See

    Define a constant instead of duplicating this literal "strlen" 6 times.
    Open

            $parts = \array_filter([$namespaceOut, $classnameOut, $identifier], 'strlen');
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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 "keyword" 4 times.
    Open

                return $this->cfg['escapeCodes']['keyword'] . 'array '
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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.

    Rename "$escapeReset" which has the same name as the field declared at line 29.
    Open

            $escapeReset = $this->escapeReset;
    Severity: Major
    Found in src/Debug/Dump/TextAnsi/Value.php by sonar-php

    Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.

    Noncompliant Code Example

    class Foo {
  public $myField;

  public function doSomething() {
    $myField = 0;
    ...
  }
}

    See

    Define a constant instead of duplicating this literal "bdk\Debug\Abstraction\Abstraction" 4 times.
    Open

            $this->debug->utility->assertType($abs, 'bdk\Debug\Abstraction\Abstraction');
    Severity: Critical
    Found in src/Debug/Dump/TextAnsi/Value.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.

    There are no issues that match your filters.

    Category
    Status