Make FormErrorIterator generic

[VincentLanglet]

Q	A
Branch?	5.4
Bug fix?	yes/no
New feature?	yes/no
Deprecations?	no
Tickets	Fix #...
License	MIT
Doc PR	symfony/symfony-docs#...

I target 5.4, since it's a follow up of #45322 which introduced some errors in my code.

It allows to typehint the Form::getErrors method to return FormErrorIterator<FormError> most of the time (which is possible by psalm/phpstan plugins with ReturnTypeProviders).

[VincentLanglet]

I added a commit to fix the psalm build @stof ; but I don't know why it wasn't failing before.

[derrabus]

I don't understand this change. The current annotations look correct to me and why would FormErrorIterator need a type variable?

[VincentLanglet]

I don't understand this change. The current annotations look correct to me and why would FormErrorIterator need a type variable?

Currently $form->getErrors() is returning FormErrorIterator which means a FormErrorIterator<FormError|FormErrorIterator>.

This can be more precise according to
https://github.com/symfony/symfony/blob/6.1/src/Symfony/Component/Form/FormInterface.php#L90-L94

$form->getErrors(), $form->getErrors(false), $form->getErrors(true) or $form->getErrors(true, true) are only returning a flatten result. So it's a FormErrorIterator<FormError> which is more precise than FormErrorIterator<FormError|FormErrorIterator>. This allow to avoid useless checks when iterating on the errors.

ReturnTypeProvider for phpstan/psalm can be implemented and already half done but they require the class to be a generic.

Knowing the result is only a FormErrorIterator can allow to write

        $errors = [];
        foreach ($form->getErrors(true) as $error) {
            $errors[] = $error->getMessage();
        }

without any complaints.

[derrabus]

$form->getErrors(), $form->getErrors(false), $form->getErrors(true) or $form->getErrors(true, true) are only returning a flatten result.

Oh right. Makes sense, thanks for the explanation.

[fabpot]

Thank you @VincentLanglet.