Mistralys / text-diff

src/Diff.php

Indentation +138 added lines, -138 removed lines

@@ -37,34 +37,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)
@@ -73,13 +73,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;
@@ -87,19 +87,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);
@@ -107,16 +107,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(
@@ -126,49 +126,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,int|string>>
-    */
+    /**
+     * 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,int|string>>
+     */
     public function toArray() : array
     {
         if($this->disposed)
@@ -242,13 +242,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);
@@ -265,15 +265,15 @@ 
         );
     }
     
-   /**
-    * 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
@@ -307,14 +307,14 @@ 
         return $table;
     }
     
-   /**
-    * Returns the partial diff for the specificed 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 specificed 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 longest common subsequence lengths
@@ -361,13 +361,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);
@@ -376,14 +376,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);
@@ -392,13 +392,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);
@@ -408,12 +408,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 = '';