[WIP][HttpFoundation] Move flash messages out of Session class and change to bucket system.

.gitignore

@@ -1,3 +1,4 @@
 phpunit.xml
 autoload.php
 /vendor/
+/nbproject/private/

CHANGELOG-2.1.md

@@ -88,6 +88,8 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
  * removed the ContentTypeMimeTypeGuesser class as it is deprecated and never used on PHP 5.3
  * added ResponseHeaderBag::makeDisposition() (implements RFC 6266)
  * made mimetype to extension conversion configurable
+ * [BC BREAK] Flashes are now stored as a bucket of messages per $type. Moved flash messages 
+   out of the session class.  Must use $session->getFlashBag() to get FlashBag instance.
 
 ### HttpKernel
 
@@ -117,4 +119,4 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
  * added a Size validator
  * added a SizeLength validator
  * improved the ImageValidator with min width, max width, min height, and max height constraints
- * added support for MIME with wildcard in FileValidator
+ * added support for MIME with wildcard in FileValidator

src/Symfony/Component/HttpFoundation/FlashBag.php

@@ -0,0 +1,156 @@
+<?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\HttpFoundation;
+
+/**
+ * FlashBag flash message container.
+ */
+class FlashBag implements FlashBagInterface
+{
+    const STATUS = 'status';
+    const ERROR = 'error';
+
+    /**
+     * Flash messages.
+     * 
+     * @var array
+     */
+    private $flashes = array();
+
+    /**
+     * Old flash messages to be purged.
+     * 
+     * @var array
+     */
+    private $oldFlashes = array();
+
+    /**
+     * @var boolean
+     */
+    private $initialized = false;
+
+    /**
+     * Initializes the FlashBag.
+     * 
+     * @param array $flashes 
+     */
+    public function initialize(array $flashes)
+    {
+        if ($this->initialized) {
+            return;
+        }
+
+        $this->flashes = $flashes;
+        $this->oldFlashes = $flashes;
+        $this->initialized = true;
+    }
+
+    /**
+     * Adds a flash to the stack for a given type.
+     * 
+     * @param string $message Message.
+     * @param string $type    Message category
+     */
+    public function add($message, $type = self::STATUS)
+    {
+        $this->flashes[$type][] = $message;
+    }
+
+    /**
+     * Gets flashes for a given type.
+     * 
+     * @return array
+     */
+    public function get($type)
+    {
+        if (!$this->has($type)) {
+            throw new \InvalidArgumentException(sprintf('Specified $type %s does not exist', $type));
+        }
+
+        return $this->flashes[$type];
+    }
+
+    /**
+     * Sets an array of flash messages for a given type.
+     * 
+     * @param string $type
+     * @param array  $array 
+     */
+    public function set($type, array $array)
+    {
+        $this->flashes[$type] = $array;
+    }
+
+    /**
+     * Has messages for a given type?
+     * 
+     * @return boolean
+     */
+    public function has($type)
+    {
+        return array_key_exists($type, $this->flashes);
+    }
+
+    /**
+     * Returns a list of all defined types.
+     * 
+     * @return array
+     */
+    public function getTypes()
+    {
+        return array_keys($this->flashes);
+    }
+
+    /**
+     * Gets all flashes.
+     * 
+     * @return array
+     */
+    public function all()
+    {
+        return $this->flashes;
+    }
+
+    /**
+     * Clears flash messages for a given type.
+     */
+    public function clear($type)
+    {
+        if (isset($this->flashes[$type])) {
+            unset($this->flashes[$type]);
+        }
+
+        if (isset($this->oldFlashes[$type])) {
+            unset($this->oldFlashes[$type]);
+        }
+    }
+
+    /**
+     * Clears all flash messages.
+     */
+    public function clearAll()
+    {
+        $this->flashes = array();
+        $this->oldFlashes = array();
+    }
+
+    /**
+     * Removes flash messages set in a previous request.
+     */
+    public function purgeOldFlashes()
+    {
+        foreach ($this->oldFlashes as $type => $flashes) {
+            $this->flashes[$type] = array_diff($this->flashes[$type], $flashes);
+        }
+    }
+
+}

src/Symfony/Component/HttpFoundation/FlashBagInterface.php

@@ -0,0 +1,83 @@
+<?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\HttpFoundation;
+
+/**
+ * FlashBagInterface.
+ * 
+ * @author Drak <drak@zikula.org>
+ */
+interface FlashBagInterface
+{
+    /**
+     * Initializes the FlashBag.
+     * 
+     * @param array $flashes 
+     */
+    function initialize(array $flashes);
+
+    /**
+     * Adds a flash to the stack for a given type.
+     */
+    function add($type, $message);
+
+    /**
+     * Gets flash messages for a given type.
+     * 
+     * @return array
+     */
+    function get($type);
+
+    /**
+     * Sets an array of flash messages for a given type.
+     * 
+     * @param string $type
+     * @param array  $array 
+     */
+    function set($type, array $array);
+
+    /**
+     * Hass flash messages for a given type?
+     * 
+     * @return boolean
+     */
+    function has($type);
+
+    /**
+     * Returns a list of all defined types.
+     * 
+     * @return array
+     */
+    function getTypes();
+
+    /**
+     * Gets all flash messages.
+     * 
+     * @return array
+     */
+    function all();
+
+    /**
+     * Clears flash messages for a given type.
+     */
+    function clear($type);
+
+    /**
+     * Clears all flash messages.
+     */
+    function clearAll();
+
+    /**
+     * Removes flash messages set in a previous request.
+     */
+    function purgeOldFlashes();
+}