Styling clean-up and additional docblocs

Author: jschroed91

lib/Caxy/HtmlDiff/Table/AbstractTableElement.php

@@ -64,7 +64,8 @@ public function getInnerHtml()
      *
      * @return string
      */
-    public function getAttribute($name) {
+    public function getAttribute($name)
+    {
         return $this->domNode->getAttribute($name);
     }
 

lib/Caxy/HtmlDiff/Table/DiffRowPosition.php

@@ -265,4 +265,4 @@ public function getLesserColumnType()
 
         return null;
     }
-}
+}

lib/Caxy/HtmlDiff/Table/RowMatch.php

@@ -29,17 +29,18 @@ class RowMatch
     protected $endInOld;
 
     /**
-     * @var int|null
+     * @var float|null
      */
     protected $percentage;
 
     /**
      * RowMatch constructor.
      *
-     * @param $startInNew
-     * @param $startInOld
-     * @param $endInNew
-     * @param $endInOld
+     * @param int        $startInNew
+     * @param int        $startInOld
+     * @param int        $endInNew
+     * @param int        $endInOld
+     * @param float|null $percentage
      */
     public function __construct($startInNew = 0, $startInOld = 0, $endInNew = 0, $endInOld = 0, $percentage = null)
     {
@@ -129,6 +130,4 @@ public function setEndInOld($endInOld)
 
         return $this;
     }
-
-
 }

lib/Caxy/HtmlDiff/Table/Table.php

@@ -9,12 +9,12 @@
 class Table extends AbstractTableElement
 {
     /**
-     * @var array
+     * @var TableRow[]
      */
     protected $rows = array();
 
     /**
-     * @return array
+     * @return TableRow[]
      */
     public function getRows()
     {

lib/Caxy/HtmlDiff/Table/TableDiff.php

@@ -23,7 +23,7 @@ class TableDiff extends AbstractDiff
     protected $newTable = null;
 
     /**
-     * @var null|Table
+     * @var null|\DOMElement
      */
     protected $diffTable = null;
 
@@ -205,8 +205,12 @@ protected function diffTableRowsWithMatches($oldRows, $newRows, $matches)
      * @param array     $appliedRowSpans
      * @param bool      $forceExpansion
      */
-    protected function processInsertOperation(Operation $operation, $newRows, &$appliedRowSpans, $forceExpansion = false)
-    {
+    protected function processInsertOperation(
+        Operation $operation,
+        $newRows,
+        &$appliedRowSpans,
+        $forceExpansion = false
+    ) {
         $targetRows = array_slice($newRows, $operation->startInNew, $operation->endInNew - $operation->startInNew);
         foreach ($targetRows as $row) {
             $this->diffAndAppendRows(null, $row, $appliedRowSpans, $forceExpansion);
@@ -219,8 +223,12 @@ protected function processInsertOperation(Operation $operation, $newRows, &$appl
      * @param array     $appliedRowSpans
      * @param bool      $forceExpansion
      */
-    protected function processDeleteOperation(Operation $operation, $oldRows, &$appliedRowSpans, $forceExpansion = false)
-    {
+    protected function processDeleteOperation(
+        Operation $operation,
+        $oldRows,
+        &$appliedRowSpans,
+        $forceExpansion = false
+    ) {
         $targetRows = array_slice($oldRows, $operation->startInOld, $operation->endInOld - $operation->startInOld);
         foreach ($targetRows as $row) {
             $this->diffAndAppendRows($row, null, $appliedRowSpans, $forceExpansion);
@@ -235,8 +243,12 @@ protected function processDeleteOperation(Operation $operation, $oldRows, &$appl
      */
     protected function processEqualOperation(Operation $operation, $oldRows, $newRows, &$appliedRowSpans)
     {
-        $targetOldRows = array_values(array_slice($oldRows, $operation->startInOld, $operation->endInOld - $operation->startInOld));
-        $targetNewRows = array_values(array_slice($newRows, $operation->startInNew, $operation->endInNew - $operation->startInNew));
+        $targetOldRows = array_values(
+            array_slice($oldRows, $operation->startInOld, $operation->endInOld - $operation->startInOld)
+        );
+        $targetNewRows = array_values(
+            array_slice($newRows, $operation->startInNew, $operation->endInNew - $operation->startInNew)
+        );
 
         foreach ($targetNewRows as $index => $newRow) {
             if (!isset($targetOldRows[$index])) {
@@ -382,12 +394,13 @@ protected function findRowMatch($newMatchData, $startInOld, $endInOld, $startInN
      * @param array         $appliedRowSpans
      * @param bool          $forceExpansion
      *
-     * @return \DOMNode
+     * @return array
      */
     protected function diffRows($oldRow, $newRow, array &$appliedRowSpans, $forceExpansion = false)
     {
         // create tr dom element
         $rowToClone = $newRow ?: $oldRow;
+        /* @var $diffRow \DOMElement */
         $diffRow = $this->diffDom->importNode($rowToClone->getDomNode()->cloneNode(false), false);
 
         $oldCells = $oldRow ? $oldRow->getCells() : array();
@@ -397,7 +410,9 @@ protected function diffRows($oldRow, $newRow, array &$appliedRowSpans, $forceExp
 
         $extraRow = null;
 
+        /* @var $expandCells \DOMElement[] */
         $expandCells = array();
+        /* @var $cellsWithMultipleRows \DOMElement[] */
         $cellsWithMultipleRows = array();
 
         $newCellCount = count($newCells);
@@ -425,6 +440,7 @@ protected function diffRows($oldRow, $newRow, array &$appliedRowSpans, $forceExp
 
             if ($oldCell && $newCell->getColspan() != $oldCell->getColspan()) {
                 if (null === $extraRow) {
+                    /* @var $extraRow \DOMElement */
                     $extraRow = $this->diffDom->importNode($rowToClone->getDomNode()->cloneNode(false), false);
                 }
 
@@ -475,14 +491,17 @@ protected function diffRows($oldRow, $newRow, array &$appliedRowSpans, $forceExp
 
         if ($extraRow) {
             foreach ($expandCells as $expandCell) {
-                $expandCell->setAttribute('rowspan', $expandCell->getAttribute('rowspan') + 1);
+                $rowspan = $expandCell->getAttribute('rowspan') ?: 1;
+                $expandCell->setAttribute('rowspan', 1 + $rowspan);
             }
         }
 
         if ($extraRow || $forceExpansion) {
             foreach ($appliedRowSpans as $rowSpanCells) {
+                /* @var $rowSpanCells \DOMElement[] */
                 foreach ($rowSpanCells as $extendCell) {
-                    $extendCell->setAttribute('rowspan', $extendCell->getAttribute('rowspan') + 1);
+                    $rowspan = $extendCell->getAttribute('rowspan') ?: 1;
+                    $extendCell->setAttribute('rowspan', 1 + $rowspan);
                 }
             }
         }
@@ -513,6 +532,7 @@ protected function getNewCellNode(TableCell $oldCell = null, TableCell $newCell
             $oldNode = $oldCell->getDomNode();
             $newNode = $newCell->getDomNode();
 
+            /* @var $clone \DOMElement */
             $clone = $newNode->cloneNode(false);
 
             $oldRowspan = $oldNode->getAttribute('rowspan') ?: 1;

lib/Caxy/HtmlDiff/Table/TableMatch.php

@@ -6,7 +6,7 @@
  * Class TableMatch
  * @package Caxy\HtmlDiff\Table
  */
-class TableMatch extends AbstractTableElement
+class TableMatch
 {
     /**
      * @var int

lib/Caxy/HtmlDiff/Table/TablePosition.php

@@ -6,7 +6,7 @@
  * Class TablePosition
  * @package Caxy\HtmlDiff\Table
  */
-class TablePosition extends AbstractTableElement
+class TablePosition
 {
     /**
      * @var int

lib/Caxy/HtmlDiff/Table/TableRow.php

@@ -14,7 +14,7 @@ class TableRow extends AbstractTableElement
     protected $table;
 
     /**
-     * @var array
+     * @var TableCell[]
      */
     protected $cells = array();
 
@@ -43,7 +43,7 @@ public function setTable(Table $table = null)
     }
 
     /**
-     * @return array
+     * @return TableCell[]
      */
     public function getCells()
     {