Sign upLogin

algb12/GraphDS

View on GitHub
Star
src/Algo/Dijkstra.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    public function run($start)
    {
        $this->start = $start;
        if (empty($this->graph->vertices[$start])) {
            throw new InvalidArgumentException("Vertex $start does not exist.");
Severity: Minor
Found in src/Algo/Dijkstra.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

Method run has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function run($start)
    {
        $this->start = $start;
        if (empty($this->graph->vertices[$start])) {
            throw new InvalidArgumentException("Vertex $start does not exist.");
Severity: Minor
Found in src/Algo/Dijkstra.php - About 1 hr to fix

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

                } else {
                throw new InvalidArgumentException("The provided graph is neither an undirected graph or a directed graph");
            }
    Severity: Minor
    Found in src/Algo/Dijkstra.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 using GraphDS\Algo\count() function in while loops.
    Open

            while (count($this->unvisitedVertices) > 0) {
            $distUnvisited = array_intersect_key($this->dist, $this->unvisitedVertices);
            $minVertexTmp = array_keys($distUnvisited, min($distUnvisited));
            $minVertex = $minVertexTmp[0];
            unset($this->unvisitedVertices[$minVertex]);
    Severity: Minor
    Found in src/Algo/Dijkstra.php by phpmd

    CountInLoopExpression

    Since: 2.7.0

    Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

    Example

    class Foo {

  public function bar()
  {
    $array = array();

    for ($i = 0; count($array); $i++) {
      // ...
    }
  }
}

    Source https://phpmd.org/rules/design.html#countinloopexpression

    Avoid excessively long variable names like $originalDestinationVertex. Keep variable name length under 20.
    Open

            $originalDestinationVertex = $destinationVertex;
    Severity: Minor
    Found in src/Algo/Dijkstra.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

    Source https://phpmd.org/rules/naming.html#longvariable

    There are no issues that match your filters.

    Category
    Status