symfony · wouterj · Sep 22, 2013 · Dec 28, 2013 · Dec 31, 2013 · stof
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -4,6 +4,12 @@ CHANGELOG
 2.5.0
 ------
 
+ * [BC BREAK] changed getErrors() to return a FormErrorBag, which is countable,
+   traversable and can be converted to a string. This breaks BC if the return
+   value is used in array function like is_array().
+ * deprecated getErrorsAsString() in favor of converting getErrors() to a
+   string
+
  * added an option for multiple files upload
 
 2.4.0

diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php
@@ -79,10 +79,11 @@ class Form implements \IteratorAggregate, FormInterface
     private $children;
 
     /**
-     * The errors of this form
-     * @var FormError[] An array of FormError instances
+     * The errors of this form.
+     *
+     * @var FormErrorBag
      */
-    private $errors = array();
+    private $errors;
    
     /**
      * Whether this form was submitted
@@ -172,6 +173,7 @@ public function __construct(FormConfigInterface $config)
 
         $this->config = $config;
         $this->children = new OrderedHashMap();
+        $this->errors = new FormErrorBag();
     }
 
     public function __clone()
@@ -501,7 +503,7 @@ public function submit($submittedData, $clearMissing = true)
 
         // Initialize errors in the very beginning so that we don't lose any
         // errors added during listeners
-        $this->errors = array();
+        $this->errors = new FormErrorBag();
 
         // Obviously, a disabled form should not change its data upon submission.
         if ($this->isDisabled()) {
@@ -675,7 +677,7 @@ public function addError(FormError $error)
         if ($this->parent && $this->config->getErrorBubbling()) {
             $this->parent->addError($error);
         } else {
-            $this->errors[] = $error;
+            $this->errors->addError($error);
         }
 
         return $this;
@@ -776,37 +778,34 @@ public function getClickedButton()
      */
     public function getErrors()
     {
-        return $this->errors;
-    }
-
-    /**
-     * Returns a string representation of all form errors (including children errors).
-     *
-     * This method should only be used to help debug a form.
-     *
-     * @param integer $level The indentation level (used internally)
-     *
-     * @return string A string representation of all errors
-     */
-    public function getErrorsAsString($level = 0)
-    {
-        $errors = '';
-        foreach ($this->errors as $error) {
-            $errors .= str_repeat(' ', $level).'ERROR: '.$error->getMessage()."\n";
-        }
+        $errors = clone $this->errors;
 
         foreach ($this->children as $key => $child) {
-            $errors .= str_repeat(' ', $level).$key.":\n";
-            if ($child instanceof self && $err = $child->getErrorsAsString($level + 4)) {
-                $errors .= $err;
-            } else {
-                $errors .= str_repeat(' ', $level + 4)."No errors\n";
+            $childrenErrors = $child->getErrors();
+
+            // for BC
+            if (is_array($childrenErrors)) {
+                $_collection = new FormErrorBag();
+                foreach ($childrenErrors as $error) {
+                    $_collection->addError($error);
+                }
+                $childrenErrors = $_collection;
             }
+
+            $errors->addCollection($key, $childrenErrors);
         }
 
         return $errors;
     }
 
+    /**
+     * @deprecated Deprecated since version 2.5, to be removed in 3.0. Convert {@link getErrors()} to a string instead.
+     */
+    public function getErrorsAsString($level = 0)
+    {
+        return $this->getErrors()->__toString($level);
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Symfony/Component/Form/FormErrorBag.php b/src/Symfony/Component/Form/FormErrorBag.php
@@ -0,0 +1,196 @@
+<?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;
+
+/**
+ * A bag of Form Errors.
+ *
+ * @author Wouter J <wouter@wouterj.nl>
+ *
+ * @since v2.5
+ */
+class FormErrorBag implements \Countable, \ArrayAccess, \IteratorAggregate
+{
+    /**
+     * @var array An array of FormError and FormErrorBag instances
+     */
+    protected $errors = array();
+
+    private $formName;
+
+    public function setFormName($name)
+    {
+        $this->formName = $name;
+    }
+
+    /**
+     * Adds a new form error.
+     *
+     * @param FormError $error
+     */
+    public function addError(FormError $error)
+    {
+        $this->errors[] = $error;
+    }
+
+    /**
+     * Adds a new form error collection.
+     *
+     * @param string       $formName
+     * @param FormErrorBag $collection
+     */
+    public function addCollection($formName, $collection)
+    {
+        $collection->setFormName($formName);
+
+        $this->errors[$formName] = $collection;
+    }
+
+    public function count()
+    {
+        $count = 0;
+
+        foreach ($this->errors as $error) {
+            if ($error instanceof FormError) {
+                $count++;
+            }
+        }
+
+        return $count;
+    }
+
+    /**
+     * Counts all errors, including errors from children.
+     *
+     * @return int
+     */
+    public function countAll()
+    {
+        $count = 0;
+
+        foreach ($this->errors as $error) {
+            if ($error instanceof FormErrorBag) {
+                $count += $error->countAll();
+            } else {
+                $count++;
+            }
+        }
+
+        return $count;
+    }
+
+    public function get($offset)
+    {
+        return $this->errors[$offset];
+    }
+
+    public function set($offset, $value)
+    {
+        $this->errors[$offset] = $value;
+    }
+
+    public function has($offset)
+    {
+        return isset($this->errors[$offset]);
+    }
+
+    public function all()
+    {
+        return $this->errors;
+    }
+
+    public function clear()
+    {
+        $this->replace();
+    }
+
+    public function remove($offset)
    {
+        unset($this->errors[$offset]);
+    }
+
+    public function replace(array $errors = array())
+    {
+        $this->errors = $errors;
+    }
+
+    public function isEmpty()
+    {
+        return empty($this->errors);
+    }
+
+    public function keys()
+    {
+        return array_keys($this->errors);
+    }
+
+    public function __toString()
+    {
+        $level = func_num_args() > 0 ? func_get_arg(0) : 0;
+        $errors = '';
+
+        foreach ($this->errors as $key => $error) {
+            if ($error instanceof self) {
+                $errors .= str_repeat(' ', $level).$key.":\n";
+                if ($err = $error->__toString($level + 4)) {
+                    $errors .= $err;
+                } else {
+                    $errors .= str_repeat(' ', $level + 4)."No errors\n";
+                }
+            } else {
+                $errors .= str_repeat(' ', $level).'ERROR: '.$error->getMessage()."\n";
+            }
+        }
+
+        return $errors;
+    }
+
+    public function offsetExists($offset)
+    {
+        return $this->has($offset) && $this->errors[$offset] instanceof FormError;
+    }
+
+    public function offsetGet($offset)
+    {
+        $error = $this->get($offset);
+
+        if ($error instanceof FormError) {
+            return $error;
+        }
+    }
+
+    public function offsetSet($offset, $value)
+    {
+        return $this->set($offset);
+    }
+
+    public function offsetUnset($offset)
+    {
+        return $this->remove($offset);
+    }
+
+    public function getIterator()
+    {
+        $errors = array_filter($this->errors, function ($error) {
+            return $error instanceof FormError;
+        });
+
+        return new \ArrayIterator($errors);
+    }
+
+    public function getAllErrors()
+    {
+        return new \RecursiveArrayIterator($this->errors);
+    }
+}
diff --git a/src/Symfony/Component/Form/FormInterface.php b/src/Symfony/Component/Form/FormInterface.php
@@ -94,7 +94,7 @@ public function all();
     /**
      * Returns all errors.
      *
-     * @return FormError[] An array of FormError instances that occurred during validation
+     * @return FormErrorBag
      */
    public function getErrors();