Removed the depricated depthFirstSearch option

Author: paquettg

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 - Curl interface and curl implementation has been removed.
+- Removed support for the depth first search option.
 
 ## 2.2.0
 

src/PHPHtmlParser/Contracts/Selector/SeekerInterface.php

@@ -13,5 +13,5 @@ interface SeekerInterface
      *
      * @throws ChildNotFoundException
      */
-    public function seek(array $nodes, RuleDTO $rule, array $options, bool $depthFirst): array;
+    public function seek(array $nodes, RuleDTO $rule, array $options): array;
 }

src/PHPHtmlParser/Contracts/Selector/SelectorInterface.php

@@ -21,8 +21,6 @@ public function __construct(string $selector, ?ParserInterface $parser = null, ?
      */
     public function getParsedSelectorCollectionDTO(): ParsedSelectorCollectionDTO;
 
-    public function setDepthFirstFind(bool $status): void;
-
     /**
      * Attempts to find the selectors starting from the given
      * node object.

src/PHPHtmlParser/Dom.php

@@ -259,12 +259,7 @@ public function find(string $selector, int $nth = null)
     {
         $this->isLoaded();
 
-        $depthFirstSearch = $this->options->get('depthFirstSearch');
-        if (\is_bool($depthFirstSearch)) {
-            $result = $this->root->find($selector, $nth, $depthFirstSearch);
-        } else {
-            $result = $this->root->find($selector, $nth);
-        }
+        $result = $this->root->find($selector, $nth);
 
         return $result;
     }

src/PHPHtmlParser/Dom/AbstractNode.php

@@ -439,13 +439,12 @@ public function ancestorByTag(string $tag): AbstractNode
      *
      * @return mixed|Collection|null
      */
-    public function find(string $selectorString, ?int $nth = null, bool $depthFirst = false, ?SelectorInterface $selector = null)
+    public function find(string $selectorString, ?int $nth = null, ?SelectorInterface $selector = null)
     {
         if (\is_null($selector)) {
             $selector = new Selector($selectorString);
         }
 
-        $selector->setDepthFirstFind($depthFirst);
         $nodes = $selector->find($this);
 
         if ($nth !== null) {

src/PHPHtmlParser/Options.php

@@ -18,7 +18,6 @@
  * @property bool        $preserveLineBreaks
  * @property bool        $removeDoubleSpace
  * @property bool        $removeSmartyScripts
- * @property bool        $depthFirstSearch
  * @property bool        $htmlSpecialCharsDecode
  */
 class Options
@@ -38,7 +37,6 @@ class Options
         'preserveLineBreaks'     => false,
         'removeDoubleSpace'      => true,
         'removeSmartyScripts'    => true,
-        'depthFirstSearch'       => false,
         'htmlSpecialCharsDecode' => false,
     ];
 
@@ -191,21 +189,6 @@ public function setRemoveSmartyScripts(bool $value): self
         return $this;
     }
 
-    /**
-     * By default this is set to false for legacy support. Setting this to true will change the behavior of find
-     * to order elements by depth first. This will properly preserve the order of elements as they where in the HTML.
-     *
-     * @return Options
-     *
-     * @deprecated This option will be removed in version 3.0.0 with the new behavior being as if it was set to true.
-     */
-    public function setDepthFirstSearch(bool $value): self
-    {
-        $this->options['depthFirstSearch'] = $value;
-
-        return $this;
-    }
-
     /**
      * 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.
      *

src/PHPHtmlParser/Selector/Seeker.php

@@ -20,7 +20,7 @@ class Seeker implements SeekerInterface
      * @var InnerNode[] $nodes
      * @throws ChildNotFoundException
      */
-    public function seek(array $nodes, RuleDTO $rule, array $options, bool $depthFirst): array
+    public function seek(array $nodes, RuleDTO $rule, array $options): array
     {
         // XPath index
         if ($rule->getTag() !== null && \is_numeric($rule->getKey())) {
@@ -80,19 +80,14 @@ public function seek(array $nodes, RuleDTO $rule, array $options, bool $depthFir
                 // this child failed to be matched
                 if ($child instanceof InnerNode && $child->hasChildren()
                 ) {
-                    if ($depthFirst) {
-                        if (!isset($options['checkGrandChildren'])
-                            || $options['checkGrandChildren']
-                        ) {
-                            // we have a child that failed but are not leaves.
-                            $matches = $this->seek([$child], $rule, $options, $depthFirst);
-                            foreach ($matches as $match) {
-                                $return[] = $match;
-                            }
+                    if (!isset($options['checkGrandChildren'])
+                        || $options['checkGrandChildren']
+                    ) {
+                        // we have a child that failed but are not leaves.
+                        $matches = $this->seek([$child], $rule, $options);
+                        foreach ($matches as $match) {
+                            $return[] = $match;
                         }
-                    } else {
-                        // we still want to check its children
-                        $children[] = $child;
                     }
                 }
 
@@ -104,7 +99,7 @@ public function seek(array $nodes, RuleDTO $rule, array $options, bool $depthFir
                 && \count($children) > 0
             ) {
                 // we have children that failed but are not leaves.
-                $matches = $this->seek($children, $rule, $options, $depthFirst);
+                $matches = $this->seek($children, $rule, $options);
                 foreach ($matches as $match) {
                     $return[] = $match;
                 }

src/PHPHtmlParser/Selector/Selector.php

@@ -25,11 +25,6 @@ class Selector implements SelectorInterface
      */
     private $ParsedSelectorCollectionDTO;
 
-    /**
-     * @var bool
-     */
-    private $depthFirst = false;
-
     /**
      * @var SeekerInterface
      */
@@ -61,11 +56,6 @@ public function getParsedSelectorCollectionDTO(): ParsedSelectorCollectionDTO
         return $this->ParsedSelectorCollectionDTO;
     }
 
-    public function setDepthFirstFind(bool $status): void
-    {
-        $this->depthFirst = $status;
-    }
-
     /**
      * Attempts to find the selectors starting from the given
      * node object.
@@ -87,7 +77,7 @@ public function find(AbstractNode $node): Collection
                     $options[] = $this->alterNext($rule);
                     continue;
                 }
-                $nodes = $this->seeker->seek($nodes, $rule, $options, $this->depthFirst);
+                $nodes = $this->seeker->seek($nodes, $rule, $options);
                 // clear the options
                 $options = [];
             }

tests/DomTest.php

@@ -483,19 +483,6 @@ public function testFindOrder()
         $dom->load($str);
         $images = $dom->find('img');
 
-        $this->assertEquals('<img src="http://example.com/second.jpg" />', (string) $images[0]);
-    }
-
-    public function testFindDepthFirstSearch()
-    {
-        $str = '<p><img src="http://example.com/first.jpg"></p><img src="http://example.com/second.jpg">';
-        $dom = new Dom();
-        $dom->setOptions([
-            'depthFirstSearch' => true,
-        ]);
-        $dom->load($str);
-        $images = $dom->find('img');
-
         $this->assertEquals('<img src="http://example.com/first.jpg" />', (string) $images[0]);
     }
 

tests/OptionsTest.php

@@ -70,7 +70,6 @@ public function testSetters()
             'preserveLineBreaks'     => false,
             'removeDoubleSpace'      => false,
             'removeSmartyScripts'    => false,
-            'depthFirstSearch'       => false,
             'htmlSpecialCharsDecode' => false,
         ]);
 
@@ -101,9 +100,6 @@ public function testSetters()
         $options->setRemoveSmartyScripts(true);
         $this->assertTrue($options->get('removeSmartyScripts'));
 
-        $options->setDepthFirstSearch(true);
-        $this->assertTrue($options->get('depthFirstSearch'));
-
         $options->setHtmlSpecialCharsDecode(true);
         $this->assertTrue($options->get('htmlSpecialCharsDecode'));
 
@@ -136,9 +132,6 @@ public function testSetters()
         $options->setRemoveSmartyScripts(false);
         $this->assertFalse($options->get('removeSmartyScripts'));
 
-        $options->setDepthFirstSearch(false);
-        $this->assertFalse($options->get('depthFirstSearch'));
-
         $options->setHtmlSpecialCharsDecode(false);
         $this->assertFalse($options->get('htmlSpecialCharsDecode'));
     }