Added missing docblocks

Author: jschroed91

lib/Caxy/HtmlDiff/AbstractDiff.php

@@ -2,25 +2,83 @@
 
 namespace Caxy\HtmlDiff;
 
+/**
+ * Class AbstractDiff
+ * @package Caxy\HtmlDiff
+ */
 abstract class AbstractDiff
 {
+    /**
+     * @var array
+     */
     public static $defaultSpecialCaseTags = array('strong', 'b', 'i', 'big', 'small', 'u', 'sub', 'sup', 'strike', 's', 'p');
+    /**
+     * @var array
+     */
     public static $defaultSpecialCaseChars = array('.', ',', '(', ')', '\'');
+    /**
+     * @var bool
+     */
     public static $defaultGroupDiffs = true;
 
+    /**
+     * @var string
+     */
     protected $content;
+    /**
+     * @var string
+     */
     protected $oldText;
+    /**
+     * @var string
+     */
     protected $newText;
+    /**
+     * @var array
+     */
     protected $oldWords = array();
+    /**
+     * @var array
+     */
     protected $newWords = array();
+    /**
+     * @var string
+     */
     protected $encoding;
+    /**
+     * @var array
+     */
     protected $specialCaseOpeningTags = array();
+    /**
+     * @var array
+     */
     protected $specialCaseClosingTags = array();
+    /**
+     * @var array|null
+     */
     protected $specialCaseTags;
+    /**
+     * @var array|null
+     */
     protected $specialCaseChars;
+    /**
+     * @var bool|null
+     */
     protected $groupDiffs;
+    /**
+     * @var int
+     */
     protected $matchThreshold = 80;
 
+    /**
+     * AbstractDiff constructor.
+     *
+     * @param string     $oldText
+     * @param string     $newText
+     * @param string     $encoding
+     * @param null|array $specialCaseTags
+     * @param null|bool  $groupDiffs
+     */
     public function __construct($oldText, $newText, $encoding = 'UTF-8', $specialCaseTags = null, $groupDiffs = null)
     {
         if ($specialCaseTags === null) {
@@ -60,25 +118,35 @@ public function setMatchThreshold($matchThreshold)
         return $this;
     }
 
-
-
+    /**
+     * @param array $chars
+     */
     public function setSpecialCaseChars(array $chars)
     {
         $this->specialCaseChars = $chars;
     }
 
+    /**
+     * @return array|null
+     */
     public function getSpecialCaseChars()
     {
         return $this->specialCaseChars;
     }
 
+    /**
+     * @param string $char
+     */
     public function addSpecialCaseChar($char)
     {
         if (!in_array($char, $this->specialCaseChars)) {
             $this->specialCaseChars[] = $char;
         }
     }
 
+    /**
+     * @param string $char
+     */
     public function removeSpecialCaseChar($char)
     {
         $key = array_search($char, $this->specialCaseChars);
@@ -87,6 +155,9 @@ public function removeSpecialCaseChar($char)
         }
     }
 
+    /**
+     * @param array $tags
+     */
     public function setSpecialCaseTags(array $tags = array())
     {
         $this->specialCaseTags = $tags;
@@ -96,6 +167,9 @@ public function setSpecialCaseTags(array $tags = array())
         }
     }
 
+    /**
+     * @param string $tag
+     */
     public function addSpecialCaseTag($tag)
     {
         if (!in_array($tag, $this->specialCaseTags)) {
@@ -113,6 +187,9 @@ public function addSpecialCaseTag($tag)
         }
     }
 
+    /**
+     * @param string $tag
+     */
     public function removeSpecialCaseTag($tag)
     {
         if (($key = array_search($tag, $this->specialCaseTags)) !== false) {
@@ -130,46 +207,85 @@ public function removeSpecialCaseTag($tag)
         }
     }
 
+    /**
+     * @return array|null
+     */
     public function getSpecialCaseTags()
     {
         return $this->specialCaseTags;
     }
 
+    /**
+     * @return string
+     */
     public function getOldHtml()
     {
         return $this->oldText;
     }
 
+    /**
+     * @return string
+     */
     public function getNewHtml()
     {
         return $this->newText;
     }
 
+    /**
+     * @return string
+     */
     public function getDifference()
     {
         return $this->content;
     }
 
+    /**
+     * @param bool $boolean
+     *
+     * @return $this
+     */
     public function setGroupDiffs($boolean)
     {
         $this->groupDiffs = $boolean;
+
+        return $this;
     }
 
+    /**
+     * @return bool
+     */
     public function isGroupDiffs()
     {
         return $this->groupDiffs;
     }
 
+    /**
+     * @param string $tag
+     *
+     * @return string
+     */
     protected function getOpeningTag($tag)
     {
         return "/<".$tag."[^>]*/i";
     }
 
+    /**
+     * @param string $tag
+     *
+     * @return string
+     */
     protected function getClosingTag($tag)
     {
         return "</".$tag.">";
     }
 
+    /**
+     * @param string $str
+     * @param string $start
+     * @param string $end
+     *
+     * @return string
+     */
     protected function getStringBetween($str, $start, $end)
     {
         $expStr = explode( $start, $str, 2 );
@@ -185,7 +301,12 @@ protected function getStringBetween($str, $start, $end)
         return '';
     }
 
-    protected function purifyHtml($html, $tags = null)
+    /**
+     * @param string $html
+     *
+     * @return string
+     */
+    protected function purifyHtml($html)
     {
         if ( class_exists( 'Tidy' ) && false ) {
             $config = array( 'output-xhtml'   => true, 'indent' => false );
@@ -205,11 +326,21 @@ protected function splitInputsToWords()
         $this->newWords = $this->convertHtmlToListOfWords( $this->explode( $this->newText ) );
     }
 
+    /**
+     * @param string $text
+     *
+     * @return bool
+     */
     protected function isPartOfWord($text)
     {
         return ctype_alnum(str_replace($this->specialCaseChars, '', $text));
     }
 
+    /**
+     * @param array $characterString
+     *
+     * @return array
+     */
     protected function convertHtmlToListOfWords($characterString)
     {
         $mode = 'character';
@@ -286,21 +417,41 @@ protected function convertHtmlToListOfWords($characterString)
         return $words;
     }
 
+    /**
+     * @param string $val
+     *
+     * @return bool
+     */
     protected function isStartOfTag($val)
     {
         return $val == "<";
     }
 
+    /**
+     * @param string $val
+     *
+     * @return bool
+     */
     protected function isEndOfTag($val)
     {
         return $val == ">";
     }
 
+    /**
+     * @param string $value
+     *
+     * @return bool
+     */
     protected function isWhiteSpace($value)
     {
         return !preg_match( '[^\s]', $value );
     }
 
+    /**
+     * @param string $value
+     *
+     * @return array
+     */
     protected function explode($value)
     {
         // as suggested by @onassar