Fixed FlashBagInterface phpdoc, clarified UPGRADE docs

This commit is contained in:
Kevin McBride 2012-09-19 13:40:59 -07:00
parent f1e6063c0a
commit bb0e4c3090
2 changed files with 8 additions and 9 deletions

View File

@ -1332,8 +1332,7 @@
### Session
* Flash messages now return an array based on their type. The old method is
still available but is now deprecated.
* Using `get` to retrieve flash messages now returns an array.
##### Retrieving the flash messages from a Twig template

View File

@ -31,18 +31,18 @@ interface FlashBagInterface extends SessionBagInterface
/**
* Registers a message for a given type.
*
* @param string $type
* @param string $message
* @param string $type
* @param string|array $message
*/
public function set($type, $message);
/**
* Gets flash message for a given type.
* Gets flash messages for a given type.
*
* @param string $type Message category type.
* @param array $default Default value if $type doee not exist.
* @param array $default Default value if $type does not exist.
*
* @return string
* @return array
*/
public function peek($type, array $default = array());
@ -57,9 +57,9 @@ interface FlashBagInterface extends SessionBagInterface
* Gets and clears flash from the stack.
*
* @param string $type
* @param array $default Default value if $type doee not exist.
* @param array $default Default value if $type does not exist.
*
* @return string
* @return array
*/
public function get($type, array $default = array());