[DomCrawler] Add method flatText()

vlakoff · vlakoff · commit 0793daf80f70 · 2017-10-03T16:48:15.000+02:00
diff --git a/src/Symfony/Component/DomCrawler/CHANGELOG.md b/src/Symfony/Component/DomCrawler/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+3.4.0
+-----
+
+* Added `flatText` method to get node value with spaces and newlines normalized.
+
 3.1.0
 -----
 
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -571,6 +571,25 @@ public function text()
         return $this->getNode(0)->nodeValue;
     }
 
+    /**
+     * Returns the flattened node value of the first node of the list.
+     *
+     * Surrounding spaces/newlines are removed,
+     * and consecutive spaces/newlines are reduced to one space.
+     *
+     * @return string The flattened node value
+     *
+     * @throws \InvalidArgumentException When current node is empty
+     */
+    public function flatText()
+    {
+        if (!$this->nodes) {
+            throw new \InvalidArgumentException('The current node list is empty.');
+        }
+
+        return trim(preg_replace('/\s+/', ' ', $this->getNode(0)->nodeValue));
+    }
+
     /**
      * Returns the first node of the list as HTML.
      *
diff --git a/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php b/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php
@@ -394,6 +394,18 @@ public function testText()
         }
     }
 
+    public function testFlatText()
+    {
+        $this->assertEquals('Fabien\'s Foo', $this->createTestCrawler()->filterXPath('//a[2]')->flatText(), '->flatText() returns the flattened node value of the first element of the node list');
+
+        try {
+            $this->createTestCrawler()->filterXPath('//ol')->flatText();
+            $this->fail('->flatText() throws an \InvalidArgumentException if the node list is empty');
+        } catch (\InvalidArgumentException $e) {
+            $this->assertTrue(true, '->flatText() throws an \InvalidArgumentException if the node list is empty');
+        }
+    }
+
     public function testHtml()
     {
         $this->assertEquals('<img alt="Bar">', $this->createTestCrawler()->filterXPath('//a[5]')->html());

Original file line number	Diff line number	Diff line change
`@@ -394,6 +394,18 @@ public function testText()`
`394`	`394`	`}`
`395`	`395`	`}`
`396`	`396`
	`397`	`+ public function testFlatText()`
	`398`	`+ {`
	`399`	`+ $this->assertEquals('Fabien\'s Foo', $this->createTestCrawler()->filterXPath('//a[2]')->flatText(), '->flatText() returns the flattened node value of the first element of the node list');`
	`400`	`+`
	`401`	`+ try {`
	`402`	`+ $this->createTestCrawler()->filterXPath('//ol')->flatText();`
	`403`	`+ $this->fail('->flatText() throws an \InvalidArgumentException if the node list is empty');`
	`404`	`+ } catch (\InvalidArgumentException $e) {`
	`405`	`+ $this->assertTrue(true, '->flatText() throws an \InvalidArgumentException if the node list is empty');`
	`406`	`+ }`
	`407`	`+ }`
	`408`	`+`
`397`	`409`	`public function testHtml()`
`398`	`410`	`{`
`399`	`411`	`$this->assertEquals('<img alt="Bar">', $this->createTestCrawler()->filterXPath('//a[5]')->html());`