Minor code improvements

jmgq · Jun 3, 2018 · 04d11f5 · 04d11f5
1 parent 1233132
commit 04d11f5
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 31 deletions.
diff --git a/examples/Graph/MyAStar.php b/examples/Graph/MyAStar.php
@@ -15,7 +15,7 @@ public function __construct(Graph $graph)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function generateAdjacentNodes(Node $node)
     {
@@ -25,7 +25,7 @@ public function generateAdjacentNodes(Node $node)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function calculateRealCost(Node $node, Node $adjacent)
     {
@@ -40,7 +40,7 @@ public function calculateRealCost(Node $node, Node $adjacent)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function calculateEstimatedCost(Node $start, Node $end)
     {

diff --git a/examples/Graph/MyNode.php b/examples/Graph/MyNode.php
@@ -24,7 +24,7 @@ public static function fromNode(Node $node)
     {
         $coordinates = explode('x', $node->getID());
 
-        if (count($coordinates) != 2) {
+        if (count($coordinates) !== 2) {
             throw new \InvalidArgumentException('Invalid node: ' . print_r($node, true));
         }
 
@@ -45,7 +45,7 @@ public function getY()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function getID()
     {

diff --git a/examples/Terrain/MyAStar.php b/examples/Terrain/MyAStar.php
@@ -15,33 +15,33 @@ public function __construct(TerrainCost $terrainCost)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function generateAdjacentNodes(Node $node)
     {
         $adjacentNodes = array();
 
         $myNode = MyNode::fromNode($node);
 
-        if ($myNode->getRow() == 0) {
+        if ($myNode->getRow() === 0) {
             $startingRow = 0;
         } else {
             $startingRow = $myNode->getRow() - 1;
         }
 
-        if ($myNode->getRow() == $this->terrainCost->getTotalRows() - 1) {
+        if ($myNode->getRow() === $this->terrainCost->getTotalRows() - 1) {
             $endingRow = $myNode->getRow();
         } else {
             $endingRow = $myNode->getRow() + 1;
         }
 
-        if ($myNode->getColumn() == 0) {
+        if ($myNode->getColumn() === 0) {
             $startingColumn = 0;
         } else {
             $startingColumn = $myNode->getColumn() - 1;
         }
 
-        if ($myNode->getColumn() == $this->terrainCost->getTotalColumns() - 1) {
+        if ($myNode->getColumn() === $this->terrainCost->getTotalColumns() - 1) {
             $endingColumn = $myNode->getColumn();
         } else {
             $endingColumn = $myNode->getColumn() + 1;
@@ -61,7 +61,7 @@ public function generateAdjacentNodes(Node $node)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function calculateRealCost(Node $node, Node $adjacent)
     {
@@ -76,7 +76,7 @@ public function calculateRealCost(Node $node, Node $adjacent)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function calculateEstimatedCost(Node $start, Node $end)
     {

diff --git a/examples/Terrain/MyNode.php b/examples/Terrain/MyNode.php
@@ -24,7 +24,7 @@ public static function fromNode(Node $node)
     {
         $rowAndColumn = explode('x', $node->getID());
 
-        if (count($rowAndColumn) != 2) {
+        if (count($rowAndColumn) !== 2) {
             throw new \InvalidArgumentException('Invalid node: ' . print_r($node, true));
         }
 
@@ -45,7 +45,7 @@ public function getColumn()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function getID()
     {

diff --git a/examples/Terrain/TerrainCost.php b/examples/Terrain/TerrainCost.php
@@ -10,22 +10,22 @@ class TerrainCost
 
     public function __construct(array $terrainCost)
     {
-        if (TerrainCost::isEmpty($terrainCost)) {
+        if (self::isEmpty($terrainCost)) {
             throw new \InvalidArgumentException('The terrain costs array is empty');
         }
 
-        if (!TerrainCost::isRectangular($terrainCost)) {
+        if (!self::isRectangular($terrainCost)) {
             throw new \InvalidArgumentException('The terrain costs array is not rectangular');
         }
 
-        $terrainCost = TerrainCost::convertToNumericArray($terrainCost);
+        $terrainCost = self::convertToNumericArray($terrainCost);
 
-        $this->terrainCost = TerrainCost::validateTerrainCosts($terrainCost);
+        $this->terrainCost = self::validateTerrainCosts($terrainCost);
     }
 
     public function getCost($row, $column)
     {
-        if (!isset($this->terrainCost[$row]) || !isset($this->terrainCost[$row][$column])) {
+        if (!isset($this->terrainCost[$row][$column])) {
             throw new \InvalidArgumentException('Invalid tile: ' . print_r($row, true) . ', ' . print_r($column, true));
         }
 
@@ -88,7 +88,7 @@ private static function isRectangular(array $terrain)
         $numberOfColumnsInFirstRow = count(reset($terrain));
 
         foreach ($terrain as $row) {
-            if (count($row) != $numberOfColumnsInFirstRow) {
+            if (count($row) !== $numberOfColumnsInFirstRow) {
                 return false;
             }
         }

diff --git a/src/CallbackAlgorithm.php b/src/CallbackAlgorithm.php
@@ -20,31 +20,26 @@ public function __construct($object, $adjacentNodesCallback, $realCostCallback,
     }
 
     /**
-     * @param Node $node
-     * @return Node[]
+     * {@inheritdoc}
      */
     public function generateAdjacentNodes(Node $node)
     {
-        return call_user_func_array(array($this->object, $this->adjacentNodesCallback), array($node));
+        return call_user_func(array($this->object, $this->adjacentNodesCallback), $node);
     }
 
     /**
-     * @param Node $node
-     * @param Node $adjacent
-     * @return integer | float
+     * {@inheritdoc}
      */
     public function calculateRealCost(Node $node, Node $adjacent)
     {
-        return call_user_func_array(array($this->object, $this->realCostCallback), array($node, $adjacent));
+        return call_user_func(array($this->object, $this->realCostCallback), $node, $adjacent);
     }
 
     /**
-     * @param Node $start
-     * @param Node $end
-     * @return integer | float
+     * {@inheritdoc}
      */
     public function calculateEstimatedCost(Node $start, Node $end)
     {
-        return call_user_func_array(array($this->object, $this->estimatedCostCallback), array($start, $end));
+        return call_user_func(array($this->object, $this->estimatedCostCallback), $start, $end);
     }
 }