[Form] Fixed FormErrorIterator class phpdoc

This commit is contained in:
Valentin 2018-12-14 13:34:58 +03:00 committed by Nicolas Grekas
parent c718a8ef30
commit 732b86317d

View File

@ -19,10 +19,9 @@ use Symfony\Component\Validator\ConstraintViolation;
/**
* Iterates over the errors of a form.
*
* Optionally, this class supports recursive iteration. In order to iterate
* recursively, set the constructor argument $deep to true. Now each element
* returned by the iterator is either an instance of {@link FormError} or of
* {@link FormErrorIterator}, in case the errors belong to a sub-form.
* This class supports recursive iteration. In order to iterate recursively,
* pass a structure of {@link FormError} and {@link FormErrorIterator} objects
* to the $errors constructor argument.
*
* You can also wrap the iterator into a {@link \RecursiveIteratorIterator} to
* flatten the recursive structure into a flat list of errors.