caxy / php-htmldiff

lib/Caxy/HtmlDiff/AbstractDiff.php

Doc Comments +7 added lines

@@ -147,6 +147,10 @@ 
         return "</".$tag.">";
     }
 
+    /**
+     * @param string $str
+     * @param string $start
+     */
     protected function getStringBetween($str, $start, $end)
     {
         $expStr = explode( $start, $str, 2 );
@@ -162,6 +166,9 @@ 
         return '';
     }
 
+    /**
+     * @param string $html
+     */
     protected function purifyHtml($html, $tags = null)
     {
         if ( class_exists( 'Tidy' ) && false ) {

lib/Caxy/HtmlDiff/ListDiff.php

Doc Comments +2 added lines, -1 removed lines

@@ -505,6 +505,7 @@ 
      * @param string $oldList
      * @param array $match
      * @param array $index
+     * @param string $type
      * @return string
      */
     protected function addListElementToContent($newList, $oldList, array $match, array $index, $type)
@@ -588,7 +589,7 @@ 
     /**
      * Converts the list (li) content arrays to string.
      *
-     * @param array $listContentArray
+     * @param string $listContentArray
      * @return string
      */
     protected function convertListContentArrayToString($listContentArray)

lib/Caxy/HtmlDiff/Match.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
     public $startInNew;
     public $size;
 
+    /**
+     * @param integer $size
+     */
     public function __construct($startInOld, $startInNew, $size)
     {
         $this->startInOld = $startInOld;

lib/Caxy/HtmlDiff/ListDiff/DiffList.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 
     protected $endTag;
 
+    /**
+     * @param null|string $listType
+     */
     public function __construct($listType, $startTag, $endTag, $listItems = array(), $attributes = array())
     {
         $this->listType = $listType;

lib/Caxy/HtmlDiff/ListDiffNew.php

Doc Comments +12 added lines

@@ -217,12 +217,18 @@ 
         return $diffList;
     }
 
+    /**
+     * @param string $type
+     */
     protected function isOpeningListTag($word, $type = null)
     {
         $filter = $type !== null ? array('<' . $type) : array('<ul', '<ol', '<dl');
         return in_array(substr($word, 0, 3), $filter);
     }
 
+    /**
+     * @param string $type
+     */
     protected function isClosingListTag($word, $type = null)
     {
         $filter = $type !== null ? array('</' . $type) : array('</ul', '</ol', '</dl');
@@ -230,6 +236,9 @@ 
         return in_array(substr($word, 0, 4), $filter);
     }
 
+    /**
+     * @param string $type
+     */
     protected function isOpeningListItemTag($word, $type = null)
     {
         $filter = $type !== null ? array('<' . $type) : array('<li', '<dd', '<dt');
@@ -237,6 +246,9 @@ 
         return in_array(substr($word, 0, 3), $filter);
     }
 
+    /**
+     * @param string $type
+     */
     protected function isClosingListItemTag($word, $type = null)
     {
         $filter = $type !== null ? array('</' . $type) : array('</li', '</dd', '</dt');

lib/Caxy/HtmlDiff/HtmlDiff.php

Doc Comments +43 added lines

@@ -173,6 +173,9 @@ 
         $this->processInsertOperation( $operation, "diffmod" );
     }
 
+    /**
+     * @param string $cssClass
+     */
     protected function processInsertOperation($operation, $cssClass)
     {
         $text = array();
@@ -190,6 +193,9 @@ 
         $this->insertTag( "ins", $cssClass, $text );
     }
 
+    /**
+     * @param string $cssClass
+     */
     protected function processDeleteOperation($operation, $cssClass)
     {
         $text = array();
@@ -231,6 +237,10 @@ 
         return $this->diffElements($oldText, $newText, $stripWrappingTags);
     }
 
+    /**
+     * @param string $oldText
+     * @param string $newText
+     */
     protected function diffElements($oldText, $newText, $stripWrappingTags = true)
     {
         $wrapStart = '';
@@ -253,6 +263,10 @@ 
         return $wrapStart . $diff->build() . $wrapEnd;
     }
 
+    /**
+     * @param string $oldText
+     * @param string $newText
+     */
     protected function diffList($oldText, $newText)
     {
         $diff = new ListDiffNew($oldText, $newText, $this->encoding, $this->specialCaseTags, $this->groupDiffs);
@@ -261,6 +275,10 @@ 
         return $diff->build();
     }
 
+    /**
+     * @param string $oldText
+     * @param string $newText
+     */
     protected function diffTables($oldText, $newText)
     {
         $diff = new TableDiff($oldText, $newText, $this->encoding, $this->specialCaseTags, $this->groupDiffs);
@@ -325,6 +343,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $text
+     */
     protected function isListPlaceholder($text)
     {
         return $this->isPlaceholderType($text, array('ol', 'dl', 'ul'));
@@ -365,6 +386,9 @@ 
         return in_array($text, $criteria, $strict);
     }
 
+    /**
+     * @param string $text
+     */
     protected function isTablePlaceholder($text)
     {
         return in_array($text, array(
@@ -372,6 +396,10 @@ 
         ), true);
     }
 
+    /**
+     * @param Operation $operation
+     * @param integer $posInNew
+     */
     protected function findIsolatedDiffTagsInOld($operation, $posInNew)
     {
         $offset = $posInNew - $operation->startInNew;
@@ -379,6 +407,9 @@ 
         return $this->oldIsolatedDiffTags[$operation->startInOld + $offset];
     }
 
+    /**
+     * @param string $tag
+     */
     protected function insertTag($tag, $cssClass, &$words)
     {
         while (true) {
@@ -440,11 +471,17 @@ 
         return $condition == 'tag' ? $this->isTag( $word ) : !$this->isTag( $word );
     }
 
+    /**
+     * @param string $text
+     */
     protected function wrapText($text, $tagName, $cssClass)
     {
         return sprintf( '<%1$s class="%2$s">%3$s</%1$s>', $tagName, $cssClass, $text );
     }
 
+    /**
+     * @param string $condition
+     */
     protected function extractConsecutiveWords(&$words, $condition)
     {
         $indexOfFirstTag = null;
@@ -537,6 +574,12 @@ 
         return $matchingBlocks;
     }
 
+    /**
+     * @param integer $startInOld
+     * @param integer $endInOld
+     * @param integer $startInNew
+     * @param integer $endInNew
+     */
     protected function findMatchingBlocks($startInOld, $endInOld, $startInNew, $endInNew, &$matchingBlocks)
     {
         $match = $this->findMatch( $startInOld, $endInOld, $startInNew, $endInNew );

lib/Caxy/HtmlDiff/Table/Table.php

Doc Comments +3 added lines

@@ -39,6 +39,9 @@
         return isset($this->rows[$index]) ? $this->rows[$index] : null;
     }
 
+    /**
+     * @param double $position
+     */
     public function insertRows($rows, $position = null)
     {
         if ($position === null) {

lib/Caxy/HtmlDiff/Table/TableDiff.php

Doc Comments +25 added lines, -1 removed lines

@@ -58,6 +58,9 @@ 
 
     protected $strategy = self::STRATEGY_MATCHING;
 
+    /**
+     * @param string $encoding
+     */
     public function __construct($oldText, $newText, $encoding, $specialCaseTags, $groupDiffs)
     {
         parent::__construct($oldText, $newText, $encoding, $specialCaseTags, $groupDiffs);
@@ -278,6 +281,10 @@ 
         }
     }
 
+    /**
+     * @param TableRow[] $oldRows
+     * @param TableRow[] $newRows
+     */
     protected function processEqualOperation($operation, $oldRows, $newRows, &$appliedRowSpans)
     {
         $targetOldRows = array_values(array_slice($oldRows, $operation->startInOld, $operation->endInOld - $operation->startInOld));
@@ -292,6 +299,10 @@ 
         }
     }
 
+    /**
+     * @param TableRow[] $oldRows
+     * @param TableRow[] $newRows
+     */
     protected function processReplaceOperation($operation, $oldRows, $newRows, &$appliedRowSpans)
     {
         $this->processDeleteOperation($operation, $oldRows, $newRows, $appliedRowSpans, true);
@@ -312,6 +323,12 @@ 
         return $matches;
     }
 
+    /**
+     * @param integer $startInOld
+     * @param integer $endInOld
+     * @param integer $startInNew
+     * @param integer $endInNew
+     */
     protected function findRowMatches($newMatchData, $startInOld, $endInOld, $startInNew, $endInNew, &$matches)
     {
         $match = $this->findRowMatch($newMatchData, $startInOld, $endInOld, $startInNew, $endInNew);
@@ -639,6 +656,9 @@ 
         $this->newTable = $this->parseTableStructure(mb_convert_encoding($this->newText, 'HTML-ENTITIES', 'UTF-8'));
     }
 
+    /**
+     * @param string $text
+     */
     protected function parseTableStructure($text)
     {
         $dom = new \DOMDocument();
@@ -704,6 +724,10 @@ 
         return trim($domDocument->saveHTML());
     }
 
+    /**
+     * @param \DOMElement $node
+     * @param string $html
+     */
     protected function setInnerHtml($node, $html)
     {
         // DOMDocument::loadHTML does not allow empty strings.
@@ -738,7 +762,7 @@ 
     }
 
     /**
-     * @param        $tableRow
+     * @param        TableRow|null $tableRow
      * @param        $currentColumn
      * @param        $targetColumn
      * @param        $currentCell