[OptionsResolver] Documented BC break in resolve()

symfony · webmozart · Dec 13, 2013 · Mar 28, 2014 · Mar 28, 2014 · Mar 30, 2014
commit bf281522ad2d6d2667ed2868670f6d9e8ddb8f4c
diff --git a/UPGRADE-2.5.md b/UPGRADE-2.5.md
@@ -45,6 +45,38 @@ Form
    {
    ```
 
+OptionsResolver
+---------------
+
+ * A new parameter `$flags` was added to `OptionsResolverInterface::resolve()`.
+   The parameter takes a bitwise combination of the new flag constants in that
+   interface.
+
+   If you implement the interface in your code, you should add the parameter as
+   well.
+
+   Before:
+
+   ```
+   public function resolve(array $options = array())
+   {
+       // ...
+   }
+   ```
+
+   After:
+
+   ```
+   public function resolve(array $options = array(), $flags = 0)
+   {
+       if ($flags & self::FORBID_UNKNOWN) {
+           // ...
+       }
+
+       // ...
+   }
+   ```
+
 Validator
 ---------
 
@@ -56,7 +88,7 @@ Validator
 
    After:
 
-   Default email validation is now done via a simple regex which may cause invalid emails (not RFC compilant) to be 
+   Default email validation is now done via a simple regex which may cause invalid emails (not RFC compilant) to be
    valid. This is the default behaviour.
 
    Strict email validation has to be explicitly activated in the configuration file by adding

diff --git a/src/Symfony/Component/OptionsResolver/CHANGELOG.md b/src/Symfony/Component/OptionsResolver/CHANGELOG.md
@@ -4,5 +4,6 @@ CHANGELOG
 2.5.0
 -----
 
+ * [BC BREAK] added parameter $flags to OptionsResolverInterface::resolve()
  * added flags FORBID_UNKNOWN, REMOVE_UNKNOWN, IGNORE_UNKNOWN, FORBID_MISSING
    and IGNORE_MISSING to OptionsResolverInterface