[DomCrawler] Added ability to return a default value in text() and html() instead of throwing an exception when node is empty.

respinoza · nicolas-grekas · commit 6a4ce386fef2 · 2018-12-17T15:56:38.000+01:00
diff --git a/src/Symfony/Component/DomCrawler/CHANGELOG.md b/src/Symfony/Component/DomCrawler/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
 * Added return of element name (`_name`) in `extract()` method.
+* Added ability to return a default value in `text()` and `html()` instead of throwing an exception when node is empty.
 
 4.2.0
 -----
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -570,13 +570,19 @@ public function nodeName()
     /**
      * Returns the node value of the first node of the list.
      *
+     * @param mixed $default When provided and the current node is empty, this value is returned and no exception is thrown
+     *
      * @return string The node value
      *
      * @throws \InvalidArgumentException When current node is empty
      */
-    public function text()
+    public function text(/* $default = null */)
     {
         if (!$this->nodes) {
+            if (0 < \func_num_args()) {
+                return \func_get_arg(0);
+            }
+
             throw new \InvalidArgumentException('The current node list is empty.');
         }
 
@@ -586,13 +592,19 @@ public function text()
     /**
      * Returns the first node of the list as HTML.
      *
+     * @param mixed $default When provided and the current node is empty, this value is returned and no exception is thrown
+     *
      * @return string The node html
      *
      * @throws \InvalidArgumentException When current node is empty
      */
-    public function html()
+    public function html(/* $default = null */)
     {
         if (!$this->nodes) {
+            if (0 < \func_num_args()) {
+                return \func_get_arg(0);
+            }
+
             throw new \InvalidArgumentException('The current node list is empty.');
         }
 
diff --git a/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php b/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php
@@ -392,6 +392,8 @@ public function testText()
         } catch (\InvalidArgumentException $e) {
             $this->assertTrue(true, '->text() throws an \InvalidArgumentException if the node list is empty');
         }
+
+        $this->assertSame('my value', $this->createTestCrawler(null)->filterXPath('//ol')->text('my value'));
     }
 
     public function testHtml()
@@ -405,6 +407,8 @@ public function testHtml()
         } catch (\InvalidArgumentException $e) {
             $this->assertTrue(true, '->html() throws an \InvalidArgumentException if the node list is empty');
         }
+
+        $this->assertSame('my value', $this->createTestCrawler(null)->filterXPath('//ol')->html('my value'));
     }
 
     public function testExtract()

Original file line number	Diff line number	Diff line change
`@@ -570,13 +570,19 @@ public function nodeName()`
`570`	`570`	`/**`
`571`	`571`	`* Returns the node value of the first node of the list.`
`572`	`572`	`*`
	`573`	`+ * @param mixed $default When provided and the current node is empty, this value is returned and no exception is thrown`
	`574`	`+ *`
`573`	`575`	`* @return string The node value`
`574`	`576`	`*`
`575`	`577`	`* @throws \InvalidArgumentException When current node is empty`
`576`	`578`	`*/`
`577`		`- public function text()`
	`579`	`+ public function text(/* $default = null */)`
`578`	`580`	`{`
`579`	`581`	`if (!$this->nodes) {`
	`582`	`+ if (0 < \func_num_args()) {`
	`583`	`+ return \func_get_arg(0);`
	`584`	`+ }`
	`585`	`+`
`580`	`586`	`throw new \InvalidArgumentException('The current node list is empty.');`
`581`	`587`	`}`
`582`	`588`
`@@ -586,13 +592,19 @@ public function text()`
`586`	`592`	`/**`
`587`	`593`	`* Returns the first node of the list as HTML.`
`588`	`594`	`*`
	`595`	`+ * @param mixed $default When provided and the current node is empty, this value is returned and no exception is thrown`
	`596`	`+ *`
`589`	`597`	`* @return string The node html`
`590`	`598`	`*`
`591`	`599`	`* @throws \InvalidArgumentException When current node is empty`
`592`	`600`	`*/`
`593`		`- public function html()`
	`601`	`+ public function html(/* $default = null */)`
`594`	`602`	`{`
`595`	`603`	`if (!$this->nodes) {`
	`604`	`+ if (0 < \func_num_args()) {`
	`605`	`+ return \func_get_arg(0);`
	`606`	`+ }`
	`607`	`+`
`596`	`608`	`throw new \InvalidArgumentException('The current node list is empty.');`
`597`	`609`	`}`
`598`	`610`
Original file line number	Diff line number	Diff line change
`@@ -392,6 +392,8 @@ public function testText()`
`392`	`392`	`} catch (\InvalidArgumentException $e) {`
`393`	`393`	`$this->assertTrue(true, '->text() throws an \InvalidArgumentException if the node list is empty');`
`394`	`394`	`}`
	`395`	`+`
	`396`	`+ $this->assertSame('my value', $this->createTestCrawler(null)->filterXPath('//ol')->text('my value'));`
`395`	`397`	`}`
`396`	`398`
`397`	`399`	`public function testHtml()`
`@@ -405,6 +407,8 @@ public function testHtml()`
`405`	`407`	`} catch (\InvalidArgumentException $e) {`
`406`	`408`	`$this->assertTrue(true, '->html() throws an \InvalidArgumentException if the node list is empty');`
`407`	`409`	`}`
	`410`	`+`
	`411`	`+ $this->assertSame('my value', $this->createTestCrawler(null)->filterXPath('//ol')->html('my value'));`
`408`	`412`	`}`
`409`	`413`
`410`	`414`	`public function testExtract()`