Classes List

Symfony\Component\Form\FormErrorIterator

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
<?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\InvalidArgumentException;
use Symfony\Component\Form\Exception\OutOfBoundsException;
use Symfony\Component\Form\Exception\BadMethodCallException;
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. * * 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. */
    const INDENTATION = ' ';

    private $form;
    private $errors;

    /** * Creates a new iterator. * * @param FormInterface $form The erroneous form * @param FormError[]|FormErrorIterator[] $errors The form errors * * @throws InvalidArgumentException If the errors are invalid */
    public function __construct(FormInterface $formarray $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__,
                    is_object($error) ? get_class($error) : gettype($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 $error FormErrorIterator */

                $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|FormErrorIterator 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->errorsinstanceof 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 = array();
        foreach ($this as $error) {
            $cause = $error->getCause();
            if ($cause instanceof ConstraintViolation && in_array($cause->getCode(), $codestrue)) {
                $errors[] = $error;
            }
        }

        return new static($this->form$errors);
    }

    /** * Utility function for indenting multi-line strings. * * @param string $string The string * * @return string The indented string */
    private static function indent($string)
    {
        return rtrim(self::INDENTATION.str_replace("\n""\n".self::INDENTATION$string), ' ');
    }
}