[Form] Changed the default value of $flatten in Form::getErrors() to true

webmozart · webmozart · commit 6b3fbb59052c · 2014-01-10T17:41:46.000+01:00
diff --git a/UPGRADE-2.5.md b/UPGRADE-2.5.md
@@ -41,6 +41,6 @@ Form
    After:
 
    ```
-   public function getErrors($deep = false, $flatten = false)
+   public function getErrors($deep = false, $flatten = true)
    {
    ```
diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -181,8 +181,8 @@ UPGRADE FROM 2.x to 3.0
    and "csrf_token_id".
 
  * The method `Form::getErrorsAsString()` was removed. Use `Form::getErrors()`
-   instead with the argument `$deep` set to true and cast the returned iterator
-   to a string (if not done implicitly by PHP).
+   instead with the argument `$deep` set to true and `$flatten` set to false
+   and cast the returned iterator to a string (if not done implicitly by PHP).
 
    Before:
 
@@ -193,7 +193,7 @@ UPGRADE FROM 2.x to 3.0
    After:
 
    ```
-   echo $form->getErrors(true);
+   echo $form->getErrors(true, false);
    ```
 
 
diff --git a/src/Symfony/Component/Form/Button.php b/src/Symfony/Component/Form/Button.php
@@ -184,7 +184,7 @@ public function all()
     /**
      * {@inheritdoc}
      */
-    public function getErrors($deep = false, $flatten = false)
+    public function getErrors($deep = false, $flatten = true)
     {
         $errors = array();
 
diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php
@@ -778,7 +778,7 @@ public function getClickedButton()
     /**
      * {@inheritdoc}
      */
-    public function getErrors($deep = false, $flatten = false)
+    public function getErrors($deep = false, $flatten = true)
     {
         return new FormErrorIterator($this->errors, $this, $deep, $flatten);
     }
@@ -797,7 +797,7 @@ public function getErrors($deep = false, $flatten = false)
      */
     public function getErrorsAsString($level = 0)
     {
-        return self::indent((string) $this->getErrors(true), $level);
+        return self::indent((string) $this->getErrors(true, false), $level);
     }
 
     /**
diff --git a/src/Symfony/Component/Form/FormErrorIterator.php b/src/Symfony/Component/Form/FormErrorIterator.php
@@ -68,7 +68,7 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
      * @param Boolean       $flatten Whether to flatten the recursive list of
      *                               errors into a flat list
      */
-    public function __construct(array &$errors, FormInterface $form, $deep = false, $flatten = false)
+    public function __construct(array &$errors, FormInterface $form, $deep = false, $flatten = true)
     {
         $this->errors = &$errors;
         $this->form = $form;
diff --git a/src/Symfony/Component/Form/FormInterface.php b/src/Symfony/Component/Form/FormInterface.php
@@ -104,7 +104,7 @@ public function all();
      * @since 2.5 Since version 2.5 this method returns a
      *            {@link FormErrorIterator} instance instead of an array
      */
-    public function getErrors($deep = false, $flatten = false);
+    public function getErrors($deep = false, $flatten = true);
 
     /**
      * Updates the form with default data.
diff --git a/src/Symfony/Component/Form/Tests/CompoundFormTest.php b/src/Symfony/Component/Form/Tests/CompoundFormTest.php
@@ -875,24 +875,17 @@ public function testGetErrorsDeep()
         $this->assertSame(
              "ERROR: Error 1\n".
              "ERROR: Error 2\n".
-             "Child:\n".
-             "    ERROR: Nested Error\n",
+             "ERROR: Nested Error\n",
              (string) $errors
         );
 
-        $errorsAsArray = iterator_to_array($errors);
-
-        $this->assertSame($error1, $errorsAsArray[0]);
-        $this->assertSame($error2, $errorsAsArray[1]);
-        $this->assertInstanceOf('Symfony\Component\Form\FormErrorIterator', $errorsAsArray[2]);
-
-        $nestedErrorsAsArray = iterator_to_array($errorsAsArray[2]);
-
-        $this->assertCount(1, $nestedErrorsAsArray);
-        $this->assertSame($nestedError, $nestedErrorsAsArray[0]);
+        $this->assertSame(
+             array($error1, $error2, $nestedError),
+             iterator_to_array($errors)
+        );
     }
 
-    public function testGetErrorsDeepFlat()
+    public function testGetErrorsDeepRecursive()
     {
         $this->form->addError($error1 = new FormError('Error 1'));
         $this->form->addError($error2 = new FormError('Error 2'));
@@ -901,19 +894,26 @@ public function testGetErrorsDeepFlat()
         $childForm->addError($nestedError = new FormError('Nested Error'));
         $this->form->add($childForm);
 
-        $errors = $this->form->getErrors(true, true);
+        $errors = $this->form->getErrors(true, false);
 
         $this->assertSame(
              "ERROR: Error 1\n".
              "ERROR: Error 2\n".
-             "ERROR: Nested Error\n",
+             "Child:\n".
+             "    ERROR: Nested Error\n",
              (string) $errors
         );
 
-        $this->assertSame(
-             array($error1, $error2, $nestedError),
-             iterator_to_array($errors)
-        );
+        $errorsAsArray = iterator_to_array($errors);
+
+        $this->assertSame($error1, $errorsAsArray[0]);
+        $this->assertSame($error2, $errorsAsArray[1]);
+        $this->assertInstanceOf('Symfony\Component\Form\FormErrorIterator', $errorsAsArray[2]);
+
+        $nestedErrorsAsArray = iterator_to_array($errorsAsArray[2]);
+
+        $this->assertCount(1, $nestedErrorsAsArray);
+        $this->assertSame($nestedError, $nestedErrorsAsArray[0]);
     }
 
     // Basic cases are covered in SimpleFormTest

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,6 @@ Form`
`41`	`41`	`After:`
`42`	`42`
`43`	`43`	```
`44`		`- public function getErrors($deep = false, $flatten = false)`
	`44`	`+ public function getErrors($deep = false, $flatten = true)`
`45`	`45`	`{`
`46`	`46`	```
Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ public function all()`
`184`	`184`	`/**`
`185`	`185`	`* {@inheritdoc}`
`186`	`186`	`*/`
`187`		`- public function getErrors($deep = false, $flatten = false)`
	`187`	`+ public function getErrors($deep = false, $flatten = true)`
`188`	`188`	`{`
`189`	`189`	`$errors = array();`
`190`	`190`
Original file line number	Diff line number	Diff line change
`@@ -778,7 +778,7 @@ public function getClickedButton()`
`778`	`778`	`/**`
`779`	`779`	`* {@inheritdoc}`
`780`	`780`	`*/`
`781`		`- public function getErrors($deep = false, $flatten = false)`
	`781`	`+ public function getErrors($deep = false, $flatten = true)`
`782`	`782`	`{`
`783`	`783`	`return new FormErrorIterator($this->errors, $this, $deep, $flatten);`
`784`	`784`	`}`
`@@ -797,7 +797,7 @@ public function getErrors($deep = false, $flatten = false)`
`797`	`797`	`*/`
`798`	`798`	`public function getErrorsAsString($level = 0)`
`799`	`799`	`{`
`800`		`- return self::indent((string) $this->getErrors(true), $level);`
	`800`	`+ return self::indent((string) $this->getErrors(true, false), $level);`
`801`	`801`	`}`
`802`	`802`
`803`	`803`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array`
`68`	`68`	`* @param Boolean $flatten Whether to flatten the recursive list of`
`69`	`69`	`* errors into a flat list`
`70`	`70`	`*/`
`71`		`- public function __construct(array &$errors, FormInterface $form, $deep = false, $flatten = false)`
	`71`	`+ public function __construct(array &$errors, FormInterface $form, $deep = false, $flatten = true)`
`72`	`72`	`{`
`73`	`73`	`$this->errors = &$errors;`
`74`	`74`	`$this->form = $form;`