merged branch jfsimon/issue-8294 (PR #8611)

fabpot · fabpot · commit 45465e4def5d · 2013-08-02T14:59:57.000+02:00
This PR was merged into the master branch. Discussion ---------- [HttpFoundation] deprecates FlashBag::getIterator() method This PR does not fix #8294 but this issue is not fixable. The `FlashBag::getIterator()` method actualy does not make any sense and is confusing. It should be removed. I just added a `@deprecated` tag and `Will be removed in 3.0.` message because removing it now would introduce a BC break. I guess issue #8294 can be closed after merge as it make not more sense than the incriminated method. | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #8294 Commits ------- ce8a7d6 [HttpFoundation] deprecated FlashBag::getIterator() method
diff --git a/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php b/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php
@@ -14,6 +14,8 @@
 /**
  * FlashBag flash message container.
  *
+ * \IteratorAggregate implementation is deprecated and will be removed in 3.0.
+ *
  * @author Drak <drak@zikula.org>
  */
 class FlashBag implements FlashBagInterface, \IteratorAggregate
@@ -167,6 +169,8 @@ public function clear()
     /**
      * Returns an iterator for flashes.
      *
+     * @deprecated Will be removed in 3.0.
+     *
      * @return \ArrayIterator An \ArrayIterator instance
      */
     public function getIterator()
