[DomCrawler] Add a way to filter only direct children nodes #28171
Comments
|
|
|
@xabbuh, thanks for your answer. Sorry, maybe I should have emphasized on this part: there is no way currently to only return I'm currently working on a project where a crawler is made of multiple different crawlers, all taking care of a small part of the DOM. They only receive the element directly (the So to keep the example above, I'm in the situation where I have a class with a method like : public function getLorems(Crawler $fooElement): array
{
// … ?
}I think it would save a lot of effort and bad risky code to add this way of filtering direct children. |
|
@javiereguiluz yes. It's not a valid selector, according to the CssSelector component.
|
|
Hi, Well technically BTW, as a workaround you maybe you could use |
|
@juanmiguelbesada It seems it does not work either. $foo->filter('.lorem')->count() // 3
$foo->children()->filter('.lorem')->count() // 3
$foo->filterXpath("/*[@class='lorem']")->count() // 0 |
|
@Einenlum |
|
@xabbuh Thanks! Your example seems to work :). So actually we could easily do something like : /**
* Returns the children nodes of the current selection.
*
* @param $selector string|null A optional CSS selector to filter children
*
* @return self
*
* @throws \InvalidArgumentException When current node is empty
* @throws \RuntimeException if the CssSelector Component is not available and $selector is provided
*/
public function children($selector = null)
{
if (!$this->nodes) {
throw new \InvalidArgumentException('The current node list is empty.');
}
if ($selector) {
if (!class_exists(CssSelectorConverter::class)) {
throw new \RuntimeException('To filter with a CSS selector, install the CssSelector component ("composer require symfony/css-selector").');
}
$converter = new CssSelectorConverter($this->isHtml);
$xpath = $converter->toXPath($selector, 'child::*/');
return $this->filterXPath($xpath);
}
$node = $this->getNode(0)->firstChild;
return $this->createSubCrawler($node ? $this->sibling($node) : array());
} $foo->children()->count() // 3
$foo->children('.lorem')->count() // 2Obviously this needs to be tested cause I'm bad at Xpath, but if it works, I think it could be really nice for the end users. |
…nlum) This PR was squashed before being merged into the 4.2-dev branch (closes #28221). Discussion ---------- [DomCrawler] Add a way to filter direct children | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #28171 | License | MIT | Doc PR | - The Dom-Crawler component only has a `filter()` method (to filter the node and all its children) and a `children()` method to return direct children. **There is currently no way to easily filter (thanks to a selector) the direct children of a node, like jQuery allows so (with a selector passed to the `.children([selector])` method).** **This PR adds a way to optionally filter direct children thanks to a CSS selector**. Here is an example of the usage: ```php $html = <<<'HTML' <html> <body> <div id="foo"> <p class="lorem" id="p1"></p> <p class="lorem" id="p2"></p> <div id="nested"> <p class="lorem" id="p3"></p> </div> </div> </body> </html> HTML; $crawler = new Crawler($html); $foo = $crawler->filter('#foo'); $foo->children() // will select `#p1`, `#p2` and `#nested` $foo->children('p') // will select `#p1` and `p2` $foo->children('.lorem') // will select `#p1` and `p2` ``` This PR adds only an optional parameter and adds no BC break. Commits ------- f634afd [DomCrawler] Add a way to filter direct children
Description
In jQuery, there is the
.find()method and the.children([selector])method. Its documentation states that :The Dom-Crawler component only has a
filter()method (to filter the node and all its children) and achildren()method to return direct children. There is no way to easily filter (thanks to a selector) the direct children of a node.I think it could be nice to add an optional
$selectorparameter to thechildren()method, to allow to filter direct children, as jQuery allows to.Example
Considering this example:
Currently, there is no way (or am I missing something?) to only return
#p1and#p2starting from the$foovariable.$foo->filter('.lorem')returns#p1,#p2and#p3.$foo->children()returns#p1,#p2and#nested.Adding this new feature would allow
$foo->children('.lorem')to return#p1and#p2.Also, since it would be an optional parameter, it would not break BC.
The text was updated successfully, but these errors were encountered: