Sign upLogin

etsy/phan

View on GitHub
Star
src/Phan/Plugin/Internal/VariableTracker/VariableGraph.php

Summary

Maintainability
A
2 hrs
Test Coverage

The class VariableGraph has 15 public methods. Consider refactoring VariableGraph to keep number of public methods under 10.
Open

final class VariableGraph
{
    /**
     * @var array<string,associative-array<int,associative-array<int,true>>>
     *
Severity: Minor
Found in src/Phan/Plugin/Internal/VariableTracker/VariableGraph.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Function computeCombinedDefUses has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    public function computeCombinedDefUses(): array
    {
        $combined_def_use_map = [];
        foreach ($this->def_uses as $var_name => $def_use_map) {
            $is_used_by_shared_state = (($this->variable_types[$var_name] ?? 0) & self::IS_REFERENCE_OR_GLOBAL_OR_STATIC) !== 0;
Severity: Minor
Found in src/Phan/Plugin/Internal/VariableTracker/VariableGraph.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

Function computeCombinedUseDefs has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    public function computeCombinedUseDefs(): array
    {
        $combined_use_def_map = [];
        foreach ($this->def_uses as $var_name => $def_use_map) {
            $is_used_by_shared_state = (($this->variable_types[$var_name] ?? 0) & self::IS_REFERENCE_OR_GLOBAL_OR_STATIC) !== 0;
Severity: Minor
Found in src/Phan/Plugin/Internal/VariableTracker/VariableGraph.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

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

    public function recordVariableUsage(string $name, Node $node, VariableTrackingScope $scope): void
    {
        if (!\array_key_exists($name, $this->variable_types)) {
            // Set this to 0 to record that the variable was used somewhere
            // (it will be overridden later if there are flags to set)
Severity: Minor
Found in src/Phan/Plugin/Internal/VariableTracker/VariableGraph.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

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

        $id = \spl_object_id($node);
Severity: Minor
Found in src/Phan/Plugin/Internal/VariableTracker/VariableGraph.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

There are no issues that match your filters.

Category
Status