feature #29127 [DomCrawler] Added return of element name in extract() method (andrey-helldar)

nicolas-grekas · nicolas-grekas · commit 4df912bf6aba · 2018-12-01T09:57:46.000+01:00
This PR was squashed before being merged into the 4.3-dev branch (closes #29127). Discussion ---------- [DomCrawler] Added return of element name in `extract()` method | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no  | Tests pass? | yes  | License | MIT | Doc PR | symfony/symfony-docs#10646 Situation: you need to get an array of keys and values. The current package code does not allow this to be done easily. The changes made to the code will allow you to return the required data set. ```php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler($content); $crawler ->filter('ItemsList > Item') ->each(function (Crawler $element) { $data = $element ->children() ->extract(['_name', '_text']); var_dump($data); }); // Result: array:2 [ 0 => array:2 [ 0 => "id", 1 => "1" ], 1 => array:2 [ 0 => "title", 1 => "Foo Bar" ] ] ``` Commits ------- 79162c1 [DomCrawler] Added return of element name in `extract()` method
diff --git a/src/Symfony/Component/DomCrawler/CHANGELOG.md b/src/Symfony/Component/DomCrawler/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+* Added return of element name (`_name`) in `extract()` method.
+
 4.2.0
 -----
 
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -658,6 +658,8 @@ public function extract($attributes)
             foreach ($attributes as $attribute) {
                 if ('_text' === $attribute) {
                     $elements[] = $node->nodeValue;
+                } elseif ('_name' === $attribute) {
+                    $elements[] = $node->nodeName;
                 } else {
                     $elements[] = $node->getAttribute($attribute);
                 }
diff --git a/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php b/src/Symfony/Component/DomCrawler/Tests/CrawlerTest.php
@@ -416,6 +416,8 @@ public function testExtract()
         $this->assertEquals(array(array(), array(), array()), $crawler->extract(array()), '->extract() returns empty arrays if the attribute list is empty');
 
         $this->assertEquals(array(), $this->createTestCrawler()->filterXPath('//ol')->extract('_text'), '->extract() returns an empty array if the node list is empty');
+
+        $this->assertEquals(array(array('One', 'li'), array('Two', 'li'), array('Three', 'li')), $crawler->extract(array('_text', '_name')), '->extract() returns an array of extracted data from the node list');
     }
 
     public function testFilterXpathComplexQueries()

Original file line number	Diff line number	Diff line change
`@@ -658,6 +658,8 @@ public function extract($attributes)`
`658`	`658`	`foreach ($attributes as $attribute) {`
`659`	`659`	`if ('_text' === $attribute) {`
`660`	`660`	`$elements[] = $node->nodeValue;`
	`661`	`+ } elseif ('_name' === $attribute) {`
	`662`	`+ $elements[] = $node->nodeName;`
`661`	`663`	`} else {`
`662`	`664`	`$elements[] = $node->getAttribute($attribute);`
`663`	`665`	`}`
Original file line number	Diff line number	Diff line change
`@@ -416,6 +416,8 @@ public function testExtract()`
`416`	`416`	`$this->assertEquals(array(array(), array(), array()), $crawler->extract(array()), '->extract() returns empty arrays if the attribute list is empty');`
`417`	`417`
`418`	`418`	`$this->assertEquals(array(), $this->createTestCrawler()->filterXPath('//ol')->extract('_text'), '->extract() returns an empty array if the node list is empty');`
	`419`	`+`
	`420`	`+ $this->assertEquals(array(array('One', 'li'), array('Two', 'li'), array('Three', 'li')), $crawler->extract(array('_text', '_name')), '->extract() returns an array of extracted data from the node list');`
`419`	`421`	`}`
`420`	`422`
`421`	`423`	`public function testFilterXpathComplexQueries()`