Static analysis error when iterating getFacet result

[rokclimb15]

Solarium version(s) affected: 6.3.7
Solr version: 7.x.x
Solr mode: cloud

Description
Iterating a getFacet result generates an error with static analysis (PHPStan)

How to reproduce

$facetResults = $resultset->getFacetSet()->getFacet('facetCounts');

foreach($facetResults as $result) {
    print_r($result);
}

Possible Solution
interface FacetResultInterface extends Iterable

Additional context
Argument of an invalid type
Solarium\Component\Result\Facet\FacetResultInterface supplied for
foreach, only iterables are supported.

[thePanz]

might be solved by #1152

[rokclimb15]

Unfortunately this is still broken in 6.4.0

[mkalkbrenner]

A PR is welcome :-)

[rokclimb15]

After studying the code a bit more, it seems that the result of $facetSet->getFacet() is not always iterable as the examples would suggest. For example Solarium\Component\Result\Facet\Aggregation isn't iterable.

Perhaps the correct path is to check if the result is iterable before iterating it and update the code examples. Thoughts?

[thomascorthals]

Perhaps the correct path is to check if the result is iterable before iterating it and update the code examples. Thoughts?

Which examples would you update?

[rokclimb15]

Perhaps the correct path is to check if the result is iterable before iterating it and update the code examples. Thoughts?

Which examples would you update?

https://github.com/solariumphp/solarium/blob/master/examples/2.1.5.1.1.1-facet-field-filters.php#L50 and similar ones, so it's clear that you aren't necessarily getting an iterable object back.