Merge pull request #40 from clue-labs/phpstan

Minor code style improvements to make PHPStan happy

Author: clue

src/BaseDual.php

@@ -2,9 +2,8 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\Base;
-use Fhaculty\Graph\Set\DualAggregate;
 use Fhaculty\Graph\Graph;
+use Fhaculty\Graph\Set\DualAggregate;
 use Fhaculty\Graph\Walk;
 
 /**
@@ -25,7 +24,7 @@ abstract class BaseDual extends Base
     /**
      * instantiate new algorithm
      *
-     * @param Graph|Walk|Set $graphOrWalk either the Graph or Walk to operate on (or the common base class Set)
+     * @param Graph|Walk|DualAggregate $graphOrWalk either the Graph or Walk to operate on (or the common base class Set)
      */
     public function __construct(DualAggregate $graphOrWalk)
     {

src/BaseGraph.php

@@ -2,7 +2,6 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\Base;
 use Fhaculty\Graph\Graph;
 
 /**

src/BaseVertex.php

@@ -2,7 +2,6 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\Base;
 use Fhaculty\Graph\Vertex;
 
 /**

src/Bipartit.php

@@ -2,17 +2,15 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
 use Fhaculty\Graph\Exception\UnexpectedValueException;
 use Fhaculty\Graph\Graph;
-use Fhaculty\Graph\Vertex;
 
 class Bipartit extends BaseGraph
 {
     /**
      * check whether this graph is bipartit
      *
-     * @return boolean
+     * @return bool
      * @uses AlgorithmBipartit::getColors()
      */
     public function isBipartit()
@@ -29,7 +27,7 @@ public function isBipartit()
     /**
      * checks whether the input graph's vertex groups are a valid bipartition
      *
-     * @return boolean
+     * @return bool
      * @uses AlgorithmGroups::isBipartit()
      */
     public function isBipartitGroups()
@@ -69,7 +67,7 @@ public function getColors()
                         // color unknown, so expect next color for this vertex
                         if (!isset($colors[$vid])) {
                             $colors[$vid] = $nextColor;
-                            $queue []= $nextVertex;
+                            $queue[] = $nextVertex;
                         // color is known but differs => can not be bipartit
                         } elseif ($colors[$vid] !== $nextColor) {
                             throw new UnexpectedValueException('Graph is not bipartit');

src/Complete.php

@@ -2,9 +2,6 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
-use Fhaculty\Graph\Graph;
-
 /**
  * Basic algorithms for working with complete graphs
  *
@@ -19,7 +16,7 @@ class Complete extends BaseGraph
     /**
      * checks whether this graph is complete (every vertex has an edge to any other vertex)
      *
-     * @return boolean
+     * @return bool
      * @uses Graph::getVertices()
      * @uses Vertex::hasEdgeTo()
      */

src/ConnectedComponents.php

@@ -2,12 +2,11 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
-use Graphp\Algorithms\Search\BreadthFirst as SearchBreadthFirst;
-use Fhaculty\Graph\Graph;
-use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Exception\InvalidArgumentException;
 use Fhaculty\Graph\Exception\UnderflowException;
+use Fhaculty\Graph\Graph;
+use Fhaculty\Graph\Vertex;
+use Graphp\Algorithms\Search\BreadthFirst as SearchBreadthFirst;
 
 /**
  * Algorithm for working with connected components
@@ -64,15 +63,14 @@ private function createSearch(Vertex $vertex)
      * As such, a null Graph (a Graph with no vertices) is not considered
      * connected here.
      *
-     * @return boolean
+     * @return bool
      * @see self::getNumberOfComponents()
      */
     public function isSingle()
     {
         try {
             $vertex = $this->graph->getVertices()->getVertexFirst();
-        }
-        catch (UnderflowException $e) {
+        } catch (UnderflowException $e) {
             // no first vertex => empty graph => has zero components
             return false;
         }
@@ -142,7 +140,7 @@ public function createGraphsComponents()
                     $visitedVertices[$vid] = true;
                 }
 
-                $graphs []= $this->graph->createGraphCloneVertices($newVertices);
+                $graphs[] = $this->graph->createGraphCloneVertices($newVertices);
             }
         }
 

src/Degree.php

@@ -2,11 +2,9 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
-use Fhaculty\Graph\Graph;
-use Fhaculty\Graph\Vertex;
+use Fhaculty\Graph\Exception\UnderflowException;
 use Fhaculty\Graph\Exception\UnexpectedValueException;
-use Fhaculty\Graph\Set\Vertices;
+use Fhaculty\Graph\Vertex;
 
 /**
  * Basic algorithms for working with the degrees of Graphs.
@@ -34,7 +32,7 @@ public function getDegree()
         $degree = $this->getDegreeVertex($this->graph->getVertices()->getVertexFirst());
 
         foreach ($this->graph->getVertices() as $vertex) {
-            /** @var $vertex Vertex */
+            assert($vertex instanceof Vertex);
             $i = $this->getDegreeVertex($vertex);
 
             if ($i !== $degree) {
@@ -49,7 +47,7 @@ public function getDegree()
      * get minimum degree of vertices
      *
      * @return int
-     * @throws Exception if graph is empty or directed
+     * @throws UnderflowException       if graph is empty
      * @uses Vertices::getVertexOrder()
      * @uses self::getDegreeVertex()
      */
@@ -62,7 +60,7 @@ public function getDegreeMin()
      * get maximum degree of vertices
      *
      * @return int
-     * @throws Exception if graph is empty or directed
+     * @throws UnderflowException       if graph is empty
      * @uses Vertices::getVertexOrder()
      * @uses self::getDegreeVertex()
      */
@@ -74,7 +72,7 @@ public function getDegreeMax()
     /**
      * checks whether this graph is regular, i.e. each vertex has the same indegree/outdegree
      *
-     * @return boolean
+     * @return bool
      * @uses self::getDegree()
      */
     public function isRegular()
@@ -95,7 +93,7 @@ public function isRegular()
     /**
      * checks whether the indegree of every vertex equals its outdegree
      *
-     * @return boolean
+     * @return bool
      * @uses self::getDegreeInVertex()
      * @uses self::getDegreeOutVertex()
      */
@@ -114,7 +112,7 @@ public function isBalanced()
      * checks whether this vertex is a source, i.e. its indegree is zero
      *
      * @param Vertex $vertex
-     * @return boolean
+     * @return bool
      * @uses Edge::hasVertexTarget()
      * @see self::getDegreeInVertex()
      */
@@ -134,7 +132,7 @@ public function isVertexSource(Vertex $vertex)
      * checks whether this vertex is a sink, i.e. its outdegree is zero
      *
      * @param Vertex $vertex
-     * @return boolean
+     * @return bool
      * @uses Edge::hasVertexStart()
      * @see self::getDegreeOutVertex()
      */
@@ -171,7 +169,7 @@ public function getDegreeVertex(Vertex $vertex)
      * check whether this vertex is isolated (i.e. has no edges attached)
      *
      * @param Vertex $vertex
-     * @return boolean
+     * @return bool
      */
     public function isVertexIsolated(Vertex $vertex)
     {

src/DetectNegativeCycle.php

@@ -2,21 +2,18 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
+use Fhaculty\Graph\Exception\NegativeCycleException;
 use Fhaculty\Graph\Exception\UnderflowException;
-
 use Fhaculty\Graph\Graph;
-use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Walk;
-use Fhaculty\Graph\Exception\NegativeCycleException;
 use Graphp\Algorithms\ShortestPath\MooreBellmanFord as SpMooreBellmanFord;
 
 class DetectNegativeCycle extends BaseGraph
 {
     /**
      * check if the input graph has any negative cycles
      *
-     * @return boolean
+     * @return bool
      * @uses AlgorithmDetectNegativeCycle::getCycleNegative()
      */
     public function hasCycleNegative()
@@ -71,7 +68,7 @@ public function getCycleNegative()
      * create new graph clone with only vertices and edges in negative cycle
      *
      * @return Graph
-     * @throws Exception if there's no negative cycle
+     * @throws UnderflowException if there's no negative cycle
      * @uses AlgorithmDetectNegativeCycle::getCycleNegative()
      * @uses Walk::createGraph()
      */

src/Directed.php

@@ -2,7 +2,6 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
 use Fhaculty\Graph\Edge\Directed as EdgeDirected;
 use Fhaculty\Graph\Edge\Undirected as EdgeUndirected;
 
@@ -20,7 +19,7 @@ class Directed extends BaseDual
      * This method is intentionally not named "isDirected()" (aka digraph),
      * because that might be misleading in regards to empty and/or mixed graphs.
      *
-     * @return boolean
+     * @return bool
      */
     public function hasDirected()
     {
@@ -39,7 +38,7 @@ public function hasDirected()
      * This method is intentionally not named "isUndirected()",
      * because that might be misleading in regards to empty and/or mixed graphs.
      *
-     * @return boolean
+     * @return bool
      */
     public function hasUndirected()
     {
@@ -55,7 +54,7 @@ public function hasUndirected()
     /**
      * checks whether this is a mixed graph (contains both directed and undirected edges)
      *
-     * @return boolean
+     * @return bool
      * @uses self::hasDirected()
      * @uses self::hasUndirected()
      */

src/Eulerian.php

@@ -2,16 +2,12 @@
 
 namespace Graphp\Algorithms;
 
-use Graphp\Algorithms\BaseGraph;
-use Fhaculty\Graph\Graph;
-use Graphp\Algorithms\Degree;
-
 class Eulerian extends BaseGraph
 {
     /**
      * check whether this graph has an eulerian cycle
      *
-     * @return boolean
+     * @return bool
      * @uses ConnectedComponents::isSingle()
      * @uses Degree::getDegreeVertex()
      * @todo isolated vertices should be ignored