Mistralys / text-diff

src/Diff.php

Indentation +95 added lines, -95 removed lines

@@ -42,14 +42,14 @@ 
     private string $string2;
     private bool $disposed = false;
 
-   /**
-    * @var string|string[]
-    */
+    /**
+     * @var string|string[]
+     */
     private $sequence1 = '';
     
-   /**
-    * @var string|string[]
-    */
+    /**
+     * @var string|string[]
+     */
     private $sequence2 = '';
     
     public function __construct(string $string1, string $string2)
@@ -58,13 +58,13 @@ 
         $this->string2 = $string2;
     }
     
-   /**
-    * Sets whether to compare single characters. Default is to 
-    * compare only lines.
-    * 
-    * @param bool $compare
-    * @return Diff
-    */
+    /**
+     * Sets whether to compare single characters. Default is to 
+     * compare only lines.
+     * 
+     * @param bool $compare
+     * @return Diff
+     */
     public function setCompareCharacters(bool $compare=true) : Diff
     {
         $this->compareCharacters = $compare;
@@ -72,19 +72,19 @@ 
         return $this;
     }
     
-   /**
-    * Returns the diff for two strings. The return value is an array, each of
-    * whose values are an array containing two values: a line (or character, if
-    * $compareCharacters is true), and one of the constants DIFF::UNMODIFIED (the
-    * line or character is in both strings), DIFF::DELETED (the line or character
-    * is only in the first string), and DIFF::INSERTED (the line or character is
-    * only in the second string).
-    * 
-    * @param string $string1
-    * @param string $string2
-    * @param bool $compareCharacters Whether to compare single characters (compares lines otherwise)
-    * @return Diff
-    */
+    /**
+     * Returns the diff for two strings. The return value is an array, each of
+     * whose values are an array containing two values: a line (or character, if
+     * $compareCharacters is true), and one of the constants DIFF::UNMODIFIED (the
+     * line or character is in both strings), DIFF::DELETED (the line or character
+     * is only in the first string), and DIFF::INSERTED (the line or character is
+     * only in the second string).
+     * 
+     * @param string $string1
+     * @param string $string2
+     * @param bool $compareCharacters Whether to compare single characters (compares lines otherwise)
+     * @return Diff
+     */
     public static function compareStrings(string $string1, string $string2, bool $compareCharacters = false) : Diff
     {
         $diff = new Diff($string1, $string2);
@@ -92,16 +92,16 @@ 
         return $diff;
     }
     
-   /**
-    * Like {@see Diff::compare()}, but returns the diff for two files.
-    *
-    * @param string $file1
-    * @param string $file2
-    * @param bool $compareCharacters Whether to compare single characters (compares lines otherwise)
-    * @return Diff
-    *
-    * @throws FileHelper_Exception If one of the files cannot be found or opened.
-    */
+    /**
+     * Like {@see Diff::compare()}, but returns the diff for two files.
+     *
+     * @param string $file1
+     * @param string $file2
+     * @param bool $compareCharacters Whether to compare single characters (compares lines otherwise)
+     * @return Diff
+     *
+     * @throws FileHelper_Exception If one of the files cannot be found or opened.
+     */
     public static function compareFiles(string $file1, string $file2, bool $compareCharacters = false) : Diff
     {
         return self::compareStrings(
@@ -111,13 +111,13 @@ 
         );
     }
     
-   /**
-    * Creates an instance of the styler class, which
-    * is used to access the CSS used for the syntax
-    * highlighting in the HTML renderers.
-    * 
-    * @return Styler
-    */
+    /**
+     * Creates an instance of the styler class, which
+     * is used to access the CSS used for the syntax
+     * highlighting in the HTML renderers.
+     * 
+     * @return Styler
+     */
     public static function createStyler() : Styler
     {
         return new Styler();
@@ -227,13 +227,13 @@ 
         return $diff;
     }
     
-   /**
-    * Splits the string into individual characters.
-    * 
-    * @param string $string
-    * @throws DiffException
-    * @return string[]
-    */
+    /**
+     * Splits the string into individual characters.
+     * 
+     * @param string $string
+     * @throws DiffException
+     * @return string[]
+     */
     private function splitString(string $string) : array
     {
         $split = preg_split('/\R/', $string);
@@ -250,15 +250,15 @@ 
         );
     }
     
-   /**
-    * Returns the table of the longest common subsequence lengths
-    * for the specified sequences.
-    * 
-    * @param int $start
-    * @param int $end1
-    * @param int $end2
-    * @return array<int,array<int,int>>
-    */
+    /**
+     * Returns the table of the longest common subsequence lengths
+     * for the specified sequences.
+     * 
+     * @param int $start
+     * @param int $end1
+     * @param int $end2
+     * @return array<int,array<int,int>>
+     */
     private function computeTable(int $start, int $end1, int $end2) : array
     {
         // determine the lengths to be compared
@@ -292,14 +292,14 @@ 
         return $table;
     }
     
-   /**
-    * Returns the partial diff for the specified sequences, in reverse order.
-    * 
-    * @param int $start
-    * @param int $end1
-    * @param int $end2
-    * @return array<int,array<int,int|string>>
-    */
+    /**
+     * Returns the partial diff for the specified sequences, in reverse order.
+     * 
+     * @param int $start
+     * @param int $end1
+     * @param int $end2
+     * @return array<int,array<int,int|string>>
+     */
     private function generatePartialDiff(int $start, int $end1, int $end2) : array
     {
         // compute the table of the longest common subsequence lengths
@@ -346,13 +346,13 @@ 
         return $diff;
     }
     
-   /**
-    * Returns a diff as a string, where unmodified lines are prefixed by '  ',
-    * deletions are prefixed by '- ', and insertions are prefixed by '+ '.
-    * 
-    * @param string $separator
-    * @return string
-    */
+    /**
+     * Returns a diff as a string, where unmodified lines are prefixed by '  ',
+     * deletions are prefixed by '- ', and insertions are prefixed by '+ '.
+     * 
+     * @param string $separator
+     * @return string
+     */
     public function toString(string $separator = "\n") : string
     {
         $renderer = new PlainText($this);
@@ -361,14 +361,14 @@ 
         return $renderer->render();
     }
     
-   /**
-    * Returns a diff as an HTML string, where unmodified lines are contained
-    * within 'span' elements, deletions are contained within 'del' elements, and
-    * insertions are contained within 'ins' elements.
-    * 
-    * @param string $separator
-    * @return string
-    */
+    /**
+     * Returns a diff as an HTML string, where unmodified lines are contained
+     * within 'span' elements, deletions are contained within 'del' elements, and
+     * insertions are contained within 'ins' elements.
+     * 
+     * @param string $separator
+     * @return string
+     */
     public function toHTML(string $separator = '<br>') : string
     {
         $renderer = new HTML($this);
@@ -377,13 +377,13 @@ 
         return $renderer->render();
     }
     
-   /**
-    * Returns a diff as an HTML table.
-    * 
-    * @param string $indentation
-    * @param string $separator
-    * @return string
-    */
+    /**
+     * Returns a diff as an HTML table.
+     * 
+     * @param string $indentation
+     * @param string $separator
+     * @return string
+     */
     public function toHTMLTable(string $indentation = '', string $separator = '<br>') : string
     {
         $renderer = new HTMLTable($this);
@@ -393,12 +393,12 @@ 
         return $renderer->render();
     }
     
-   /**
-    * Disposes of the diff by clearing the stored strings,
-    * to free memory until the class is destructed.
-    * 
-    * @return Diff
-    */
+    /**
+     * Disposes of the diff by clearing the stored strings,
+     * to free memory until the class is destructed.
+     * 
+     * @return Diff
+     */
     public function dispose() : Diff
     {
         $this->string1 = '';

Spacing +17 added lines, -17 removed lines

@@ -65,7 +65,7 @@ 
     * @param bool $compare
     * @return Diff
     */
-    public function setCompareCharacters(bool $compare=true) : Diff
+    public function setCompareCharacters(bool $compare = true) : Diff
     {
         $this->compareCharacters = $compare;
         
@@ -157,7 +157,7 @@ 
      */
     public function toArray() : array
     {
-        if($this->disposed)
+        if ($this->disposed)
         {
             throw new DiffException(
                 'The diff has been disposed.',
@@ -189,14 +189,14 @@ 
         // skip any common prefix
         while ($start <= $end1 && $start <= $end2 && $this->sequence1[$start] === $this->sequence2[$start])
         {
-            $start ++;
+            $start++;
         }
         
         // skip any common suffix
         while ($end1 >= $start && $end2 >= $start && $this->sequence1[$end1] === $this->sequence2[$end2])
         {
-            $end1 --;
-            $end2 --;
+            $end1--;
+            $end2--;
         }
         
         // generate the partial diff
@@ -205,7 +205,7 @@ 
         // generate the full diff
         $diff = array();
         
-        for ($index = 0; $index < $start; $index ++)
+        for ($index = 0; $index < $start; $index++)
         {
             $diff[] = array($this->sequence1[$index], self::UNMODIFIED);
         }
@@ -215,7 +215,7 @@ 
             $diff[] = array_pop($partialDiff);
         }
         
-        for ($index = $end1 + 1; $index < $totalSequence; $index ++)
+        for ($index = $end1 + 1; $index < $totalSequence; $index++)
         {
             $diff[] = array($this->sequence1[$index], self::UNMODIFIED);
         }
@@ -238,7 +238,7 @@ 
     {
         $split = preg_split('/\R/', $string);
         
-        if(is_array($split))
+        if (is_array($split))
         {
             return $split;
         }
@@ -269,19 +269,19 @@ 
         $table = array(array_fill(0, $length2 + 1, 0));
         
         // loop over the rows
-        for ($index1 = 1; $index1 <= $length1; $index1 ++){
+        for ($index1 = 1; $index1 <= $length1; $index1++) {
             
             // create the new row
             $table[$index1] = array(0);
             
             // loop over the columns
-            for ($index2 = 1; $index2 <= $length2; $index2 ++){
+            for ($index2 = 1; $index2 <= $length2; $index2++) {
                 
                 // store the longest common subsequence length
                 if ($this->sequence1[$index1 + $start - 1]
-                    === $this->sequence2[$index2 + $start - 1]){
+                    === $this->sequence2[$index2 + $start - 1]) {
                         $table[$index1][$index2] = $table[$index1 - 1][$index2 - 1] + 1;
-                }else{
+                } else {
                     $table[$index1][$index2] =
                     max($table[$index1 - 1][$index2], $table[$index1][$index2 - 1]);
                 }
@@ -320,11 +320,11 @@ 
                 $index1 > 0 && $index2 > 0
                 && $this->sequence1[$index1 + $start - 1]
                 === $this->sequence2[$index2 + $start - 1]
-            ){
+            ) {
                 // update the diff and the indices
                 $diff[] = array($this->sequence1[$index1 + $start - 1], self::UNMODIFIED);
-                $index1 --;
-                $index2 --;
+                $index1--;
+                $index2--;
             }
             elseif (
                 $index2 > 0
@@ -332,13 +332,13 @@ 
             ) {
                 // update the diff and the indices
                 $diff[] = array($this->sequence2[$index2 + $start - 1], self::INSERTED);
-                $index2 --;
+                $index2--;
             }
             else
             {
                 // update the diff and the indices
                 $diff[] = array($this->sequence1[$index1 + $start - 1], self::DELETED);
-                $index1 --;
+                $index1--;
             }
         }
         

Braces +4 added lines, -7 removed lines

@@ -176,8 +176,7 @@ 
             $end1 = strlen($this->string1) - 1;
             $end2 = strlen($this->string2) - 1;
             $totalSequence = strlen($this->sequence1);
-        }
-        else
+        } else
         {
             $this->sequence1 = $this->splitString($this->string1);
             $this->sequence2 = $this->splitString($this->string2);
@@ -281,7 +280,7 @@ 
                 if ($this->sequence1[$index1 + $start - 1]
                     === $this->sequence2[$index2 + $start - 1]){
                         $table[$index1][$index2] = $table[$index1 - 1][$index2 - 1] + 1;
-                }else{
+                } else{
                     $table[$index1][$index2] =
                     max($table[$index1 - 1][$index2], $table[$index1][$index2 - 1]);
                 }
@@ -325,16 +324,14 @@ 
                 $diff[] = array($this->sequence1[$index1 + $start - 1], self::UNMODIFIED);
                 $index1 --;
                 $index2 --;
-            }
-            elseif (
+            } elseif (
                 $index2 > 0
                 && $table[$index1][$index2] === $table[$index1][$index2 - 1]
             ) {
                 // update the diff and the indices
                 $diff[] = array($this->sequence2[$index2 + $start - 1], self::INSERTED);
                 $index2 --;
-            }
-            else
+            } else
             {
                 // update the diff and the indices
                 $diff[] = array($this->sequence1[$index1 + $start - 1], self::DELETED);

src/Diff/Renderer/HTMLTable.php

Indentation +31 added lines, -31 removed lines

@@ -15,20 +15,20 @@ 
     private string $nl = PHP_EOL;
     private string $container = '<table class="text-diff-container">%s</table>';
 
-   /**
-    * @var array<int, array<int,int|string>>
-    */
+    /**
+     * @var array<int, array<int,int|string>>
+     */
     private $array;
 
-   /**
-    * Sets the tab character(s) to indent the HTML code with.
-    * This is used to indent the table's tags beyond the
-    * base indentation.
-    * 
-    * @param string $tab
-    * @return HTMLTable
-    * @see HTMLTable::setIndentation()
-    */
+    /**
+     * Sets the tab character(s) to indent the HTML code with.
+     * This is used to indent the table's tags beyond the
+     * base indentation.
+     * 
+     * @param string $tab
+     * @return HTMLTable
+     * @see HTMLTable::setIndentation()
+     */
     public function setTab(string $tab) : HTMLTable
     {
         $this->tab = $tab;
@@ -46,11 +46,11 @@ 
         return $this->nl;
     }
     
-   /**
-    * Sets the character
-    * @param string $separator
-    * @return HTMLTable
-    */
+    /**
+     * Sets the character
+     * @param string $separator
+     * @return HTMLTable
+     */
     public function setSeparator(string $separator) : HTMLTable
     {
         $this->separator = $separator;
@@ -58,13 +58,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the character(s) to indent the whole table with.
-    *  
-    * @param string $indent
-    * @return HTMLTable
-    * @see HTMLTable::setTab()
-    */
+    /**
+     * Sets the character(s) to indent the whole table with.
+     *  
+     * @param string $indent
+     * @return HTMLTable
+     * @see HTMLTable::setTab()
+     */
     public function setIndentation(string $indent) : HTMLTable
     {
         $this->indentation = $indent;
@@ -173,13 +173,13 @@ 
         return 'unmodified';
     }
     
-   /**
-    * Returns the content of the cell.
-    * 
-    * @param int $index
-    * @param int $type The operation type (inset/delete/unmodified)
-    * @return string
-    */
+    /**
+     * Returns the content of the cell.
+     * 
+     * @param int $index
+     * @param int $type The operation type (inset/delete/unmodified)
+     * @return string
+     */
     private function getCellContent(int &$index, int $type) : string
     {
         // initialise the HTML

Spacing +12 added lines, -12 removed lines

@@ -133,24 +133,24 @@ 
             
             // extend the HTML with the new row
             $html .=
-            $i2. "<tr>". $nl . 
-            $i3.     '<td class="text-diff-'.$leftType. '">'. $leftCell . "</td>".$nl.
-            $i3.     '<td class="text-diff-'.$rightType. '">'. $rightCell . "</td>".$nl.
-            $i2. "</tr>".$nl;
+            $i2."<tr>".$nl. 
+            $i3.'<td class="text-diff-'.$leftType.'">'.$leftCell."</td>".$nl.
+            $i3.'<td class="text-diff-'.$rightType.'">'.$rightCell."</td>".$nl.
+            $i2."</tr>".$nl;
                                                 
         }
         
-        return $i1. sprintf($this->container, $nl.$html).$nl;
+        return $i1.sprintf($this->container, $nl.$html).$nl;
     }
     
     private function resolveLeftType(string $leftCell, string $rightCell) : string
     {
-        if(empty($leftCell))
+        if (empty($leftCell))
         {
             return 'empty';
         }
         
-        if($leftCell !== $rightCell)
+        if ($leftCell !== $rightCell)
         {
             return 'del';
         }
@@ -160,12 +160,12 @@ 
     
     private function resolveRightType(string $leftCell, string $rightCell) : string
     {
-        if(empty($rightCell))
+        if (empty($rightCell))
         {
             return 'empty';
         }
         
-        if($leftCell !== $rightCell)
+        if ($leftCell !== $rightCell)
         {
             return 'ins';
         }
@@ -192,11 +192,11 @@ 
             $html .= sprintf(
                 '<%1$s>%2$s</%1$s>%3$s',
                 $tag,
-                htmlspecialchars((string)$this->array[$index][0]),
+                htmlspecialchars((string) $this->array[$index][0]),
                 $this->separator
             );
             
-            $index ++;
+            $index++;
         }
         
         return $html;
@@ -204,7 +204,7 @@ 
     
     private function resolveTag(int $type) : string
     {
-        switch($type)
+        switch ($type)
         {
             case Diff::DELETED: return 'del';
             case Diff::INSERTED: return 'ins';

src/Diff/Renderer/HTML.php

Spacing +3 added lines, -3 removed lines

@@ -48,14 +48,14 @@
             switch ($line[1])
             {
                 case Diff::UNMODIFIED : $element = 'span'; break;
-                case Diff::DELETED    : $element = 'del';  break;
-                case Diff::INSERTED   : $element = 'ins';  break;
+                case Diff::DELETED    : $element = 'del'; break;
+                case Diff::INSERTED   : $element = 'ins'; break;
             }
             
             $html .= sprintf(
                 '<%1$s>%2$s</%1$s>',
                 $element,
-                htmlspecialchars((string)$line[0])
+                htmlspecialchars((string) $line[0])
             );
             
             // extend the HTML with the separator

src/Diff/Renderer.php

Indentation +3 added lines, -3 removed lines

@@ -15,8 +15,8 @@
         $this->diff = $diff;
     }
     
-   /**
-    * @return mixed
-    */
+    /**
+     * @return mixed
+     */
     abstract public function render();
 }

src/Diff/Styler.php

Indentation +12 added lines, -12 removed lines

@@ -79,23 +79,23 @@
         );
     }
     
-   /**
-    * Retrieves the path to the stylesheet file.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the path to the stylesheet file.
+     * 
+     * @return string
+     */
     public function getStylesheetPath() : string
     {
         return $this->path;
     }
     
-   /**
-    * Retrieves the URL to the stylesheet file, given the
-    * local URL to the application's vendor folder.
-    *  
-    * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot).
-    * @return string
-    */
+    /**
+     * Retrieves the URL to the stylesheet file, given the
+     * local URL to the application's vendor folder.
+     *  
+     * @param string $vendorURL The URL to the vendor folder (must be accessible in the webroot).
+     * @return string
+     */
     public function getStylesheetURL(string $vendorURL) : string
     {
         return sprintf(