feature #10418 [Form] Removed "magic" from FormErrorIterator (webmozart)

fabpot · fabpot · commit c2d4be1d6b6c · 2014-03-11T18:20:42.000+01:00
This PR was merged into the 2.5-dev branch. Discussion ---------- [Form] Removed "magic" from FormErrorIterator | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- daac66e [Form] Removed "magic" from FormErrorIterator
diff --git a/src/Symfony/Component/Form/Button.php b/src/Symfony/Component/Form/Button.php
@@ -186,9 +186,7 @@ public function all()
      */
     public function getErrors($deep = false, $flatten = true)
     {
-        $errors = array();
-
-        return new FormErrorIterator($errors, $this, $deep, $flatten);
+        return new FormErrorIterator($this, array());
     }
 
     /**
diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php
@@ -780,7 +780,33 @@ public function getClickedButton()
      */
     public function getErrors($deep = false, $flatten = true)
     {
-        return new FormErrorIterator($this->errors, $this, $deep, $flatten);
+        $errors = $this->errors;
+
+        // Copy the errors of nested forms to the $errors array
+        if ($deep) {
+            foreach ($this as $child) {
+                /** @var FormInterface $child */
+                if ($child->isSubmitted() && $child->isValid()) {
+                    continue;
+                }
+
+                $iterator = $child->getErrors(true, $flatten);
+
+                if (0 === count($iterator)) {
+                    continue;
+                }
+
+                if ($flatten) {
+                    foreach ($iterator as $error) {
+                        $errors[] = $error;
+                    }
+                } else {
+                    $errors[] = $iterator;
+                }
+            }
+        }
+
+        return new FormErrorIterator($this, $errors);
     }
 
     /**
diff --git a/src/Symfony/Component/Form/FormErrorIterator.php b/src/Symfony/Component/Form/FormErrorIterator.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Form;
 
+use Symfony\Component\Form\Exception\InvalidArgumentException;
 use Symfony\Component\Form\Exception\OutOfBoundsException;
 use Symfony\Component\Form\Exception\BadMethodCallException;
 
@@ -44,38 +45,33 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
     private $form;
 
     /**
-     * @var Boolean
+     * @var FormError[]|FormErrorIterator[]
      */
-    private $deep;
-
-    /**
-     * @var Boolean
-     */
-    private $flatten;
-
-    /**
-     * @var array
-     */
-    private $elements;
+    private $errors;
 
     /**
      * Creates a new iterator.
      *
-     * @param array         $errors  The iterated errors
-     * @param FormInterface $form    The form the errors belong to
-     * @param Boolean       $deep    Whether to include the errors of child
-     *                               forms
-     * @param Boolean       $flatten Whether to flatten the recursive list of
-     *                               errors into a flat list
+     * @param FormInterface $form   The erroneous form
+     * @param array         $errors The form errors
+     *
+     * @throws InvalidArgumentException If the errors are invalid
      */
-    public function __construct(array &$errors, FormInterface $form, $deep = false, $flatten = true)
+    public function __construct(FormInterface $form, array $errors)
     {
-        $this->errors = &$errors;
-        $this->form = $form;
-        $this->deep = $deep;
-        $this->flatten = $flatten;
+        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->rewind();
+        $this->form = $form;
+        $this->errors = $errors;
     }
 
     /**
@@ -87,13 +83,13 @@ public function __toString()
     {
         $string = '';
 
-        foreach ($this->elements as $element) {
-            if ($element instanceof FormError) {
-                $string .= 'ERROR: '.$element->getMessage()."\n";
+        foreach ($this->errors as $error) {
+            if ($error instanceof FormError) {
+                $string .= 'ERROR: '.$error->getMessage()."\n";
             } else {
-                /** @var $element FormErrorIterator */
-                $string .= $element->form->getName().":\n";
-                $string .= self::indent((string) $element);
+                /** @var $error FormErrorIterator */
+                $string .= $error->form->getName().":\n";
+                $string .= self::indent((string) $error);
             }
         }
 
@@ -113,20 +109,20 @@ public function getForm()
     /**
      * Returns the current element of the iterator.
      *
-     * @return FormError|FormErrorIterator An error or an iterator for nested
-     *                                     errors.
+     * @return FormError|FormErrorIterator An error or an iterator containing
+     *                                     nested errors.
      */
     public function current()
     {
-        return current($this->elements);
+        return current($this->errors);
     }
 
     /**
      * Advances the iterator to the next position.
      */
     public function next()
     {
-        next($this->elements);
+        next($this->errors);
     }
 
     /**
@@ -136,7 +132,7 @@ public function next()
      */
     public function key()
     {
-        return key($this->elements);
+        return key($this->errors);
     }
 
     /**
@@ -146,7 +142,7 @@ public function key()
      */
     public function valid()
     {
-        return null !== key($this->elements);
+        return null !== key($this->errors);
     }
 
     /**
@@ -157,32 +153,7 @@ public function valid()
      */
     public function rewind()
     {
-        $this->elements = $this->errors;
-
-        if ($this->deep) {
-            foreach ($this->form as $child) {
-                /** @var FormInterface $child */
-                if ($child->isSubmitted() && $child->isValid()) {
-                    continue;
-                }
-
-                $iterator = $child->getErrors(true, $this->flatten);
-
-                if (0 === count($iterator)) {
-                    continue;
-                }
-
-                if ($this->flatten) {
-                    foreach ($iterator as $error) {
-                        $this->elements[] = $error;
-                    }
-                } else {
-                    $this->elements[] = $iterator;
-                }
-            }
-        }
-
-        reset($this->elements);
+        reset($this->errors);
     }
 
     /**
@@ -194,7 +165,7 @@ public function rewind()
      */
     public function offsetExists($position)
     {
-        return isset($this->elements[$position]);
+        return isset($this->errors[$position]);
     }
 
     /**
@@ -208,11 +179,11 @@ public function offsetExists($position)
      */
     public function offsetGet($position)
     {
-        if (!isset($this->elements[$position])) {
+        if (!isset($this->errors[$position])) {
             throw new OutOfBoundsException('The offset '.$position.' does not exist.');
         }
 
-        return $this->elements[$position];
+        return $this->errors[$position];
     }
 
     /**
@@ -243,15 +214,15 @@ public function offsetUnset($position)
      */
     public function hasChildren()
     {
-        return current($this->elements) instanceof self;
+        return current($this->errors) instanceof self;
     }
 
     /**
      * Alias of {@link current()}.
      */
     public function getChildren()
     {
-        return current($this->elements);
+        return current($this->errors);
     }
 
     /**
@@ -273,7 +244,7 @@ public function getChildren()
      */
     public function count()
     {
-        return count($this->elements);
+        return count($this->errors);
     }
 
     /**
@@ -285,14 +256,14 @@ public function count()
      */
     public function seek($position)
     {
-        if (!isset($this->elements[$position])) {
+        if (!isset($this->errors[$position])) {
             throw new OutOfBoundsException('The offset '.$position.' does not exist.');
         }
 
-        reset($this->elements);
+        reset($this->errors);
 
-        while ($position !== key($this->elements)) {
-            next($this->elements);
+        while ($position !== key($this->errors)) {
+            next($this->errors);
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -186,9 +186,7 @@ public function all()`
`186`	`186`	`*/`
`187`	`187`	`public function getErrors($deep = false, $flatten = true)`
`188`	`188`	`{`
`189`		`- $errors = array();`
`190`		`-`
`191`		`- return new FormErrorIterator($errors, $this, $deep, $flatten);`
	`189`	`+ return new FormErrorIterator($this, array());`
`192`	`190`	`}`
`193`	`191`
`194`	`192`	`/**`