Should we adapt getErrors() or add a new method getErrorIterator()? https://github.com/symfony/symfony/pull/9918 (Poll Closed) (poll 7853158)

Should we adapt getErrors() or add a new method getErrorIterator()? https://github.com/symfony/symfony/pull/9918 (Poll Closed)

Add the parameters $deep and $flatten to getErrors() and change the return type to FormErrorIterator. BC breaks: Implementations of FormInterface must add the (optional) parameters. People who use getErrors() may need to use iterator_to_array(). 51% (30 votes)
Leave getErrors() unchanged. Add the new functionality to getErrorIterator() (or a similarly named method) instead. BC breaks: Implementations of FormInterface need to add the new method. 49% (29 votes)

Total Votes: 59

Martin Hlaváč - 10 years ago

@bschussek I woud much rather see new method than adding magical switches as parameters to existing ones. New method is easier to find and use - It's obvious what it does.
bschussek - 10 years ago

@Hugo: That doesn't really make sense. We can't specify in a type hint, for example, that a class should implement both interfaces.
Hugo Hamon - 10 years ago

For BC I think it's safer to add a new method and deprecate the previous one (to be removed in 3.0). Instead of modifying the current FormInterface, why not adding a new FormErrorInterface so that a Form instance implements both FormInterface and FormErrorInterface? Those two interfaces may be merged in branch 3.0.
Baptiste Clavié - 10 years ago

Even though we're actually using getErrors, I think that rather than having x methods (getErrorIterator, getErrorAsString, getErrorAsUnicorns, ....) it should be better to have an iterator once and for all.