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(

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

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

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

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 = '';