Added feature paquettg#164

Author: paquettg

CHANGELOG.md

@@ -13,7 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added new option `depthFirstSearch`.
 - Deprecated option `depthFirstSearch` and marked for removal in `3.0.0`.
 - Added multi class selections support.
-- Added case insensitive attribute matching
+- Added case insensitive attribute matching.
+- Added new option `htmlSpecialCharsDecode`.
 
 ### Changed
 - Started using a changelog.

README.md

@@ -188,6 +188,10 @@ By default this is set to `false` for legacy support. Setting this to `true` wil
 
 This option is depricated and will be removed in version `3.0.0` with the new behavior being as if it was set to `true`.
 
+**htmlSpecialCharsDecode**
+
+By default this is set to `false`. Setting this to `true` will apply the php function `htmlspecialchars_decode` too all attribute values and text nodes.
+
 Static Facade
 -------------
 

src/PHPHtmlParser/Dom.php

@@ -533,6 +533,7 @@ protected function parse(): void
     {
         // add the root node
         $this->root = new HtmlNode('root');
+        $this->root->setHtmlSpecialCharsDecode($this->options->htmlSpecialCharsDecode);
         $activeNode = $this->root;
         while ( ! is_null($activeNode)) {
             $str = $this->content->copyUntil('<');
@@ -580,6 +581,7 @@ protected function parse(): void
             ) {
                 // we found text we care about
                 $textNode = new TextNode($str, $this->options->removeDoubleSpace);
+                $textNode->setHtmlSpecialCharsDecode($this->options->htmlSpecialCharsDecode);
                 $activeNode->addChild($textNode);
             }
         }
@@ -634,6 +636,7 @@ protected function parseTag(): array
             return $return;
         }
         $node = new HtmlNode($tag);
+        $node->setHtmlSpecialCharsDecode($this->options->htmlSpecialCharsDecode);
 
         // attributes
         while ($this->content->char() != '>' &&

src/PHPHtmlParser/Dom/AbstractNode.php

@@ -65,6 +65,11 @@ abstract class AbstractNode
      */
     protected $children = [];
 
+    /**
+     * @var bool
+     */
+    protected $htmlSpecialCharsDecode = false;
+
     /**
      * Creates a unique id for this node.
      */
@@ -123,6 +128,16 @@ public function __toString()
         return $this->outerHtml();
     }
 
+    /**
+     * @param bool $htmlSpecialCharsDecode
+     * @return void
+     */
+    public function setHtmlSpecialCharsDecode($htmlSpecialCharsDecode = false): void
+    {
+        $this->htmlSpecialCharsDecode = $htmlSpecialCharsDecode;
+    }
+
+
     /**
      * Reset node counter
      *

src/PHPHtmlParser/Dom/HtmlNode.php

@@ -55,6 +55,16 @@ public function __construct($tag)
         parent::__construct();
     }
 
+    /**
+     * @param bool $htmlSpecialCharsDecode
+     * @return void
+     */
+    public function setHtmlSpecialCharsDecode($htmlSpecialCharsDecode = false): void
+    {
+        parent::setHtmlSpecialCharsDecode($htmlSpecialCharsDecode);
+        $this->tag->setHtmlSpecialCharsDecode($htmlSpecialCharsDecode);
+    }
+
     /**
      * Gets the inner html of this node.
      *

src/PHPHtmlParser/Dom/Tag.php

@@ -52,6 +52,11 @@ class Tag
      */
     protected $encode = null;
 
+    /**
+     * @var bool
+     */
+    private $HtmlSpecialCharsDecode = false;
+
     /**
      * Sets up the tag with a name.
      *
@@ -142,6 +147,15 @@ public function setEncoding(Encode $encode): void
         $this->encode = $encode;
     }
 
+    /**
+     * @param bool $htmlSpecialCharsDecode
+     * @return void
+     */
+    public function setHtmlSpecialCharsDecode($htmlSpecialCharsDecode = false): void
+    {
+        $this->HtmlSpecialCharsDecode = $htmlSpecialCharsDecode;
+    }
+
     /**
      * Sets the noise for this tag (if any)
      *
@@ -173,6 +187,9 @@ public function setAttribute(string $key, $value): Tag
                 'doubleQuote' => true,
             ];
         }
+        if ($this->HtmlSpecialCharsDecode) {
+            $value['value'] = htmlspecialchars_decode($value['value']);
+        }
         $this->attr[$key] = $value;
 
         return $this;
@@ -186,7 +203,6 @@ public function setAttribute(string $key, $value): Tag
      */
     public function setStyleAttributeValue($attr_key, $attr_value): void
     {
-
         $style_array = $this->getStyleAttributeArray();
         $style_array[$attr_key] = $attr_value;
 

src/PHPHtmlParser/Dom/TextNode.php

@@ -51,28 +51,43 @@ public function __construct(string $text, $removeDoubleSpace = true)
         parent::__construct();
     }
 
+    /**
+     * @param bool $htmlSpecialCharsDecode
+     * @return void
+     */
+    public function setHtmlSpecialCharsDecode($htmlSpecialCharsDecode = false): void
+    {
+        parent::setHtmlSpecialCharsDecode($htmlSpecialCharsDecode);
+        $this->tag->setHtmlSpecialCharsDecode($htmlSpecialCharsDecode);
+    }
+
     /**
      * Returns the text of this node.
      *
      * @return string
      */
     public function text(): string
     {
+        if ($this->htmlSpecialCharsDecode) {
+            $text = htmlspecialchars_decode($this->text);
+        } else {
+            $text = $this->text;
+        }
         // convert charset
         if ( ! is_null($this->encode)) {
             if ( ! is_null($this->convertedText)) {
                 // we already know the converted value
                 return $this->convertedText;
             }
-            $text = $this->encode->convert($this->text);
+            $text = $this->encode->convert($text);
 
             // remember the conversion
             $this->convertedText = $text;
 
             return $text;
-        } else {
-            return $this->text;
         }
+
+        return $text;
     }
 
     /**
@@ -84,7 +99,6 @@ public function text(): string
     public function setText(string $text): void
     {
         $this->text = $text;
-
         if ( ! is_null($this->encode)) {
             $text = $this->encode->convert($text);
 

src/PHPHtmlParser/Options.php

@@ -15,6 +15,7 @@
  * @property bool removeDoubleSpace
  * @property bool removeSmartyScripts
  * @property bool depthFirstSearch
+ * @property bool htmlSpecialCharsDecode
  */
 class Options
 {
@@ -25,16 +26,17 @@ class Options
      * @param array
      */
     protected $defaults = [
-        'whitespaceTextNode'   => true,
-        'strict'               => false,
-        'enforceEncoding'      => null,
-        'cleanupInput'         => true,
-        'removeScripts'        => true,
-        'removeStyles'         => true,
-        'preserveLineBreaks'   => false,
-        'removeDoubleSpace'    => true,
-        'removeSmartyScripts'  => true,
-        'depthFirstSearch'     => false,
+        'whitespaceTextNode'     => true,
+        'strict'                 => false,
+        'enforceEncoding'        => null,
+        'cleanupInput'           => true,
+        'removeScripts'          => true,
+        'removeStyles'           => true,
+        'preserveLineBreaks'     => false,
+        'removeDoubleSpace'      => true,
+        'removeSmartyScripts'    => true,
+        'depthFirstSearch'       => false,
+        'htmlSpecialCharsDecode' => false,
     ];
 
     /**

tests/DomTest.php

@@ -404,6 +404,17 @@ public function testGetComplexAttribute()
         $this->assertEquals('?search=Fort+William&session_type=face&distance=100&uqs=119846&page=4', $href);
     }
 
+    public function testGetComplexAttributeHtmlSpecialCharsDecode()
+    {
+        $dom = new Dom;
+        $dom->setOptions(['htmlSpecialCharsDecode' => true]);
+        $dom->load('<a href="?search=Fort+William&amp;session_type=face&amp;distance=100&amp;uqs=119846&amp;page=4" class="pagination-next">Next <span class="chevron">&gt;</span></a>');
+        $a    = $dom->find('a', 0);
+        $this->assertEquals('Next <span class="chevron">></span>', $a->innerHtml);
+        $href = $a->href;
+        $this->assertEquals('?search=Fort+William&session_type=face&distance=100&uqs=119846&page=4', $href);
+    }
+
     public function testGetChildrenNoChildren()
     {
         $dom = new Dom();