123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Form;
- use Symfony\Component\Form\Exception\BadMethodCallException;
- use Symfony\Component\Form\Exception\InvalidArgumentException;
- use Symfony\Component\Form\Exception\OutOfBoundsException;
- use Symfony\Component\Validator\ConstraintViolation;
- /**
- * Iterates over the errors of a 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.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \ArrayAccess, \Countable
- {
- /**
- * The prefix used for indenting nested error messages.
- */
- public const INDENTATION = ' ';
- private $form;
- private $errors;
- /**
- * @param FormError[]|self[] $errors An array of form errors and instances
- * of FormErrorIterator
- *
- * @throws InvalidArgumentException If the errors are invalid
- */
- public function __construct(FormInterface $form, array $errors)
- {
- foreach ($errors as $error) {
- if (!($error instanceof FormError || $error instanceof self)) {
- throw new InvalidArgumentException(sprintf('The errors must be instances of "Symfony\Component\Form\FormError" or "%s". Got: "%s".', __CLASS__, get_debug_type($error)));
- }
- }
- $this->form = $form;
- $this->errors = $errors;
- }
- /**
- * Returns all iterated error messages as string.
- *
- * @return string The iterated error messages
- */
- public function __toString()
- {
- $string = '';
- foreach ($this->errors as $error) {
- if ($error instanceof FormError) {
- $string .= 'ERROR: '.$error->getMessage()."\n";
- } else {
- /* @var self $error */
- $string .= $error->form->getName().":\n";
- $string .= self::indent((string) $error);
- }
- }
- return $string;
- }
- /**
- * Returns the iterated form.
- *
- * @return FormInterface The form whose errors are iterated by this object
- */
- public function getForm()
- {
- return $this->form;
- }
- /**
- * Returns the current element of the iterator.
- *
- * @return FormError|self An error or an iterator containing nested errors
- */
- public function current()
- {
- return current($this->errors);
- }
- /**
- * Advances the iterator to the next position.
- */
- public function next()
- {
- next($this->errors);
- }
- /**
- * Returns the current position of the iterator.
- *
- * @return int The 0-indexed position
- */
- public function key()
- {
- return key($this->errors);
- }
- /**
- * Returns whether the iterator's position is valid.
- *
- * @return bool Whether the iterator is valid
- */
- public function valid()
- {
- return null !== key($this->errors);
- }
- /**
- * Sets the iterator's position to the beginning.
- *
- * This method detects if errors have been added to the form since the
- * construction of the iterator.
- */
- public function rewind()
- {
- reset($this->errors);
- }
- /**
- * Returns whether a position exists in the iterator.
- *
- * @param int $position The position
- *
- * @return bool Whether that position exists
- */
- public function offsetExists($position)
- {
- return isset($this->errors[$position]);
- }
- /**
- * Returns the element at a position in the iterator.
- *
- * @param int $position The position
- *
- * @return FormError|FormErrorIterator The element at the given position
- *
- * @throws OutOfBoundsException If the given position does not exist
- */
- public function offsetGet($position)
- {
- if (!isset($this->errors[$position])) {
- throw new OutOfBoundsException('The offset '.$position.' does not exist.');
- }
- return $this->errors[$position];
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function offsetSet($position, $value)
- {
- throw new BadMethodCallException('The iterator doesn\'t support modification of elements.');
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function offsetUnset($position)
- {
- throw new BadMethodCallException('The iterator doesn\'t support modification of elements.');
- }
- /**
- * Returns whether the current element of the iterator can be recursed
- * into.
- *
- * @return bool Whether the current element is an instance of this class
- */
- public function hasChildren()
- {
- return current($this->errors) instanceof self;
- }
- /**
- * Alias of {@link current()}.
- */
- public function getChildren()
- {
- return current($this->errors);
- }
- /**
- * Returns the number of elements in the iterator.
- *
- * Note that this is not the total number of errors, if the constructor
- * parameter $deep was set to true! In that case, you should wrap the
- * iterator into a {@link \RecursiveIteratorIterator} with the standard mode
- * {@link \RecursiveIteratorIterator::LEAVES_ONLY} and count the result.
- *
- * $iterator = new \RecursiveIteratorIterator($form->getErrors(true));
- * $count = count(iterator_to_array($iterator));
- *
- * Alternatively, set the constructor argument $flatten to true as well.
- *
- * $count = count($form->getErrors(true, true));
- *
- * @return int The number of iterated elements
- */
- public function count()
- {
- return \count($this->errors);
- }
- /**
- * Sets the position of the iterator.
- *
- * @param int $position The new position
- *
- * @throws OutOfBoundsException If the position is invalid
- */
- public function seek($position)
- {
- if (!isset($this->errors[$position])) {
- throw new OutOfBoundsException('The offset '.$position.' does not exist.');
- }
- reset($this->errors);
- while ($position !== key($this->errors)) {
- next($this->errors);
- }
- }
- /**
- * Creates iterator for errors with specific codes.
- *
- * @param string|string[] $codes The codes to find
- *
- * @return static new instance which contains only specific errors
- */
- public function findByCodes($codes)
- {
- $codes = (array) $codes;
- $errors = [];
- foreach ($this as $error) {
- $cause = $error->getCause();
- if ($cause instanceof ConstraintViolation && \in_array($cause->getCode(), $codes, true)) {
- $errors[] = $error;
- }
- }
- return new static($this->form, $errors);
- }
- /**
- * Utility function for indenting multi-line strings.
- */
- private static function indent(string $string): string
- {
- return rtrim(self::INDENTATION.str_replace("\n", "\n".self::INDENTATION, $string), ' ');
- }
- }
|