feature #42338 [DomCrawler] Added Crawler::innerText() method (Bilge)

fabpot · fabpot · commit 0ddeeff95601 · 2021-09-21T08:44:17.000+02:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [DomCrawler] Added Crawler::innerText() method | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #42294 | License | MIT | Doc PR | symfony/symfony-docs#...  Adds a method to get the inner text that is directly descended from the current node only, ignoring text nodes in any child nodes. Commits ------- 4767694 [DomCrawler] Added Crawler::innerText() method
diff --git a/src/Symfony/Component/DomCrawler/CHANGELOG.md b/src/Symfony/Component/DomCrawler/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.4
+---
+
+ * Add `Crawler::innerText` method.
+
 5.3
 ---
 
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -634,6 +634,14 @@ public function text(string $default = null, bool $normalizeWhitespace = true)
         return $text;
     }
 
+    /**
+     * Returns only the inner text that is the direct descendent of the current node, excluding any child nodes.
+     */
+    public function innerText(): string
+    {
+        return $this->filterXPath('.//text()')->text();
+    }
+
     /**
      * Returns the first node of the list as HTML.
      *
diff --git a/src/Symfony/Component/DomCrawler/Tests/AbstractCrawlerTest.php b/src/Symfony/Component/DomCrawler/Tests/AbstractCrawlerTest.php
@@ -354,6 +354,18 @@ public function testText()
         $this->assertSame('my value', $this->createTestCrawler(null)->filterXPath('//ol')->text('my value'));
     }
 
+    /**
+     * Tests that innerText() returns only text that is the direct descendent of the current node, in contrast to
+     * text() that returns the text of all child nodes.
+     */
+    public function testInnerText()
+    {
+        self::assertCount(1, $crawler = $this->createTestCrawler()->filterXPath('//*[@id="complex-element"]'));
+
+        self::assertSame('Parent text Child text', $crawler->text());
+        self::assertSame('Parent text', $crawler->innerText());
+    }
+
     public function testHtml()
     {
         $this->assertEquals('<img alt="Bar">', $this->createTestCrawler()->filterXPath('//a[5]')->html());
@@ -1283,6 +1295,10 @@ public function createTestCrawler($uri = null)
                         <div id="child2" xmlns:foo="http://example.com"></div>
                     </div>
                     <div id="sibling"><img /></div>
+                    <div id="complex-element">
+                        Parent text
+                        <span>Child text</span>
+                    </div>
                 </body>
             </html>
         ');

Original file line number	Diff line number	Diff line change
`@@ -634,6 +634,14 @@ public function text(string $default = null, bool $normalizeWhitespace = true)`
`634`	`634`	`return $text;`
`635`	`635`	`}`
`636`	`636`
	`637`	`+ /**`
	`638`	`+ * Returns only the inner text that is the direct descendent of the current node, excluding any child nodes.`
	`639`	`+ */`
	`640`	`+ public function innerText(): string`
	`641`	`+ {`
	`642`	`+ return $this->filterXPath('.//text()')->text();`
	`643`	`+ }`
	`644`	`+`
`637`	`645`	`/**`
`638`	`646`	`* Returns the first node of the list as HTML.`
`639`	`647`	`*`