Mistralys / text-diff

src/Diff/Renderer.php

Indentation +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@
 
 abstract class Renderer
 {
-   /**
-    * @var Diff
-    */
+    /**
+     * @var Diff
+     */
     protected $diff;
     
     public function __construct(Diff $diff)

src/Diff/Styler.php

Indentation +29 added lines, -29 removed lines

@@ -26,14 +26,14 @@ 
 {
     const ERROR_CSS_FILE_NOT_FOUND = 66801;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $fileName = 'styles.css';
     
     public function __construct()
@@ -56,22 +56,22 @@ 
         $this->path = $path;
     }
    
-   /**
-    * Retrieves the raw CSS source for the highlighting.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the raw CSS source for the highlighting.
+     * 
+     * @return string
+     */
     public function getCSS() : string
     {
         return FileHelper::readContents($this->path);
     }
     
-   /**
-    * Retrieves a fully formed `code` tag with the CSS,
-    * to inject inline into an HTML document.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a fully formed `code` tag with the CSS,
+     * to inject inline into an HTML document.
+     * 
+     * @return string
+     */
     public function getStyleTag() : string
     {
         return sprintf(
@@ -80,23 +80,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(

Spacing +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
         $folder = sprintf(__DIR__.'/../../css/%s', $this->fileName);
         $path = realpath($folder);
         
-        if($path === false)
+        if ($path === false)
         {
             throw new DiffException(
                 'Could not find the highlight CSS file',

src/Diff/Renderer/HTML.php

Indentation +6 added lines, -6 removed lines

@@ -8,14 +8,14 @@
 
 class HTML extends Renderer
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $separator = '<br>';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $container = '<div class="text-diff-container">%s</div>';
     
     public function setSeparator(string $separator) : HTML

Spacing +2 added lines, -2 removed lines

@@ -48,8 +48,8 @@
             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(

src/Diff/Renderer/PlainText.php

Indentation +3 added lines, -3 removed lines

@@ -8,9 +8,9 @@
 
 class PlainText extends Renderer
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $separator = "\n";
     
     public function setSeparator(string $separator) : PlainText

Spacing +3 added lines, -3 removed lines

@@ -36,9 +36,9 @@
             // extend the string with the line
             switch ($line[1])
             {
-                case Diff::UNMODIFIED : $string .= '  ' . $line[0];break;
-                case Diff::DELETED    : $string .= '- ' . $line[0];break;
-                case Diff::INSERTED   : $string .= '+ ' . $line[0];break;
+                case Diff::UNMODIFIED : $string .= '  '.$line[0]; break;
+                case Diff::DELETED    : $string .= '- '.$line[0]; break;
+                case Diff::INSERTED   : $string .= '+ '.$line[0]; break;
             }
             
             // extend the string with the separator

src/Diff/Renderer/HTMLTable.php

Indentation +51 added lines, -51 removed lines

@@ -13,40 +13,40 @@ 
      */
     private $separator = '<br>';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $indentation = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $tab = '    ';
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     private $array;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $nl = PHP_EOL;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $container = '<table class="text-diff-container">%s</table>';
     
-   /**
-    * 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;
@@ -62,11 +62,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;
@@ -74,13 +74,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;
@@ -98,14 +98,14 @@ 
         return $this->indentation;
     }
     
-   /**
-    * Returns a diff as an HTML table.
-    *
-    * @param array $this->array
-    * @param string $indentation
-    * @param string $separator
-    * @return string
-    */
+    /**
+     * Returns a diff as an HTML table.
+     *
+     * @param array $this->array
+     * @param string $indentation
+     * @param string $separator
+     * @return string
+     */
     public function render() : string
     {
         $this->array = $this->diff->toArray();
@@ -189,13 +189,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 +11 added lines, -11 removed lines

@@ -149,24 +149,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';
         }
         
-        else if($leftCell !== $rightCell)
+        else if ($leftCell !== $rightCell)
         {
             return 'del';
         }
@@ -176,12 +176,12 @@ 
     
     private function resolveRightType(string $leftCell, string $rightCell) : string
     {
-        if(empty($rightCell))
+        if (empty($rightCell))
         {
             return 'empty';
         }
         
-        else if($leftCell !== $rightCell)
+        else if ($leftCell !== $rightCell)
         {
             return 'ins';
         }
@@ -212,7 +212,7 @@ 
                 $this->separator
             );
             
-            $index ++;
+            $index++;
         }
         
         return $html;
@@ -220,7 +220,7 @@ 
     
     private function resolveTag(int $type) : string
     {
-        switch($type)
+        switch ($type)
         {
             case Diff::DELETED: return 'del';
             case Diff::INSERTED: return 'ins';

Braces +2 added lines, -6 removed lines

@@ -164,9 +164,7 @@ 
         if(empty($leftCell))
         {
             return 'empty';
-        }
-        
-        else if($leftCell !== $rightCell)
+        } else if($leftCell !== $rightCell)
         {
             return 'del';
         }
@@ -179,9 +177,7 @@ 
         if(empty($rightCell))
         {
             return 'empty';
-        }
-        
-        else if($leftCell !== $rightCell)
+        } else if($leftCell !== $rightCell)
         {
             return 'ins';
         }

src/Diff.php

Indentation +133 added lines, -133 removed lines

@@ -36,34 +36,34 @@ 
     const DELETED    = 1;
     const INSERTED   = 2;
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $compareCharacters = false;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $string1;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $string2;
     
-   /**
-    * @var string|string[]
-    */
+    /**
+     * @var string|string[]
+     */
     private $sequence1 = '';
     
-   /**
-    * @var string|string[]
-    */
+    /**
+     * @var string|string[]
+     */
     private $sequence2 = '';
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private $disposed = false;
     
     public function __construct(string $string1, string $string2)
@@ -72,13 +72,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;
@@ -86,19 +86,19 @@ 
         return $this;
     }
     
-   /**
-    * Returns the diff for two strings. The return value is an array, each of
-    * whose values is 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 is 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);
@@ -106,16 +106,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::compare(
@@ -125,49 +125,49 @@ 
         );
     }
     
-   /**
-    * 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();
     }
     
-   /**
-    * Retrieves the raw array that contains the diff definitions
-    * for the two strings.
-    * 
-    * For example, comparing the following strings:
-    * 
-    * Hello word
-    * Hello world
-    * 
-    * Will return the following array:
-    * 
-    * <pre>
-    * Array(
-    *   [0] => Array
-    *   (
-    *     [0] => Hello word
-    *     [1] => 1
-    *   )
-    *   [1] => Array
-    *   (
-    *     [0] => Hello world
-    *     [1] => 2
-    *   )
-    * )
-    * </pre>
-    * 
-    * Where the second entry in the sub-array is the status 
-    * code, e.g. Diff::DELETED, Diff::INSERTED.
-    * 
-    * @return array<int,array<int,mixed>>
-    */
+    /**
+     * Retrieves the raw array that contains the diff definitions
+     * for the two strings.
+     * 
+     * For example, comparing the following strings:
+     * 
+     * Hello word
+     * Hello world
+     * 
+     * Will return the following array:
+     * 
+     * <pre>
+     * Array(
+     *   [0] => Array
+     *   (
+     *     [0] => Hello word
+     *     [1] => 1
+     *   )
+     *   [1] => Array
+     *   (
+     *     [0] => Hello world
+     *     [1] => 2
+     *   )
+     * )
+     * </pre>
+     * 
+     * Where the second entry in the sub-array is the status 
+     * code, e.g. Diff::DELETED, Diff::INSERTED.
+     * 
+     * @return array<int,array<int,mixed>>
+     */
     public function toArray() : array
     {
         if($this->disposed)
@@ -242,15 +242,15 @@ 
         return $diff;
     }
     
-   /**
-    * Returns the table of 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 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
@@ -284,13 +284,13 @@ 
         return $table;
     }
     
-   /**
-    * Returns the partial diff for the specificed sequences, in reverse order.
-    * 
-    * @param array<int,array<int,int>> $table
-    * @param int $start
-    * @return array<int,array<int,string>>
-    */
+    /**
+     * Returns the partial diff for the specificed sequences, in reverse order.
+     * 
+     * @param array<int,array<int,int>> $table
+     * @param int $start
+     * @return array<int,array<int,string>>
+     */
     private function generatePartialDiff(array $table, int $start) : array
     {
         //  initialise the diff
@@ -334,14 +334,14 @@ 
         return $diff;
     }
     
-   /**
-    * Returns a diff as a string, where unmodified lines are prefixed by '  ',
-    * deletions are prefixed by '- ', and insertions are prefixed by '+ '.
-    * 
-    * @param array $diff
-    * @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 array $diff
+     * @param string $separator
+     * @return string
+     */
     public function toString(string $separator = "\n") : string
     {
         $renderer = new PlainText($this);
@@ -350,15 +350,15 @@ 
         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 array $diff
-    * @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 array $diff
+     * @param string $separator
+     * @return string
+     */
     public function toHTML(string $separator = '<br>') : string
     {
         $renderer = new HTML($this);
@@ -367,14 +367,14 @@ 
         return $renderer->render();
     }
     
-   /**
-    * Returns a diff as an HTML table.
-    * 
-    * @param array $diff
-    * @param string $indentation
-    * @param string $separator
-    * @return string
-    */
+    /**
+     * Returns a diff as an HTML table.
+     * 
+     * @param array $diff
+     * @param string $indentation
+     * @param string $separator
+     * @return string
+     */
     public function toHTMLTable(string $indentation = '', string $separator = '<br>') : string
     {
         $renderer = new HTMLTable($this);
@@ -384,12 +384,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 +16 added lines, -16 removed lines

@@ -79,7 +79,7 @@ 
     * @param bool $compare
     * @return Diff
     */
-    public function setCompareCharacters(bool $compare=true) : Diff
+    public function setCompareCharacters(bool $compare = true) : Diff
     {
         $this->compareCharacters = $compare;
         
@@ -170,7 +170,7 @@ 
     */
     public function toArray() : array
     {
-        if($this->disposed)
+        if ($this->disposed)
         {
             throw new DiffException(
                 'The diff has been disposed.',
@@ -200,14 +200,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--;
         }
         
         // compute the table of longest common subsequence lengths
@@ -219,7 +219,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);
         }
@@ -231,7 +231,7 @@ 
         
         $max = ($this->compareCharacters ? strlen($this->sequence1) : count($this->sequence1));
         
-        for ($index = $end1 + 1; $index < $max; $index ++)
+        for ($index = $end1 + 1; $index < $max; $index++)
         {
             $diff[] = array($this->sequence1[$index], self::UNMODIFIED);
         }
@@ -261,19 +261,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]);
                 }
@@ -308,11 +308,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
@@ -320,13 +320,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

@@ -188,8 +188,7 @@ 
             $this->sequence2 = $this->string2;
             $end1 = strlen($this->string1) - 1;
             $end2 = strlen($this->string2) - 1;
-        }
-        else
+        } else
         {
             $this->sequence1 = preg_split('/\R/', $this->string1);
             $this->sequence2 = preg_split('/\R/', $this->string2);
@@ -273,7 +272,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]);
                 }
@@ -313,16 +312,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);