# FlashBagInterface

interface FlashBagInterface implements SessionBagInterface

FlashBagInterface.

## Methods

`public` | `string` | `getName()` | Gets this bag's name. | from SessionBagInterface
`public` | `` | `initialize(array $array)` | Initializes the Bag. | from SessionBagInterface
`public` | `string` | `getStorageKey()` | Gets the storage key for this bag. | from SessionBagInterface
`public` | `mixed` | `clear()` | Clears out data from bag. | from SessionBagInterface
`public` | `` | `add(string $type, string $message)` | Adds a flash message for type. |
`public` | `` | `set(string $type, string|array $message)` | Registers a message for a given type. |
`public` | `array` | `peek(string $type, array $default = array())` | Gets flash messages for a given type. |
`public` | `array` | `peekAll()` | Gets all flash messages. |
`public` | `array` | `get(string $type, array $default = array())` | Gets and clears flash from the stack. |
`public` | `array` | `all()` | Gets and clears flashes from the stack. |
`public` | `` | `setAll(array $messages)` | Sets all flash messages. |
`public` | `bool` | `has(string $type)` | Has flash messages for a given type? |
`public` | `array` | `keys()` | Returns a list of all defined types. |

## Details

in SessionBagInterface at line 26

### `getName()`

`public string getName()`

Gets this bag's name.

#### Return Value

`string` |

in SessionBagInterface at line 31

### `initialize()`

`public initialize(array $array)`

Initializes the Bag.

#### Parameters

`array` | `$array` |

in SessionBagInterface at line 38

### `getStorageKey()`

`public string getStorageKey()`

Gets the storage key for this bag.

#### Return Value

`string` |

in SessionBagInterface at line 45

### `clear()`

`public mixed clear()`

Clears out data from bag.

#### Return Value

`mixed` | Whatever data was contained

at line 29

### `add()`

`public add(string $type, string $message)`

Adds a flash message for type.

#### Parameters

`string` | `$type` |
`string` | `$message` |

at line 37

### `set()`

`public set(string $type, string|array $message)`

Registers a message for a given type.

#### Parameters

`string` | `$type` |
`string|array` | `$message` |

at line 47

### `peek()`

`public array peek(string $type, array $default = array())`

Gets flash messages for a given type.

#### Parameters

`string` | `$type` | Message category type
`array` | `$default` | Default value if $type does not exist

#### Return Value

`array` |

at line 54

### `peekAll()`

`public array peekAll()`

Gets all flash messages.

#### Return Value

`array` |

at line 64

### `get()`

`public array get(string $type, array $default = array())`

Gets and clears flash from the stack.

#### Parameters

`string` | `$type` |
`array` | `$default` | Default value if $type does not exist

#### Return Value

`array` |

at line 71

### `all()`

`public array all()`

Gets and clears flashes from the stack.

#### Return Value

`array` |

at line 76

### `setAll()`

`public setAll(array $messages)`

Sets all flash messages.

#### Parameters

`array` | `$messages` |

at line 85

### `has()`

`public bool has(string $type)`

Has flash messages for a given type?

#### Parameters

`string` | `$type` |

#### Return Value

`bool` |

at line 92

### `keys()`

`public array keys()`

Returns a list of all defined types.

#### Return Value

`array` |

## Source code

    <?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\Session\Flash;

    use Symfony\Component\HttpFoundation\Session\SessionBagInterface;

    /**
     * FlashBagInterface.
     *
     * @author Drak <drak@zikula.org>
     */
    interface FlashBagInterface extends SessionBagInterface
    {
        /**
         * Adds a flash message for type.
         *
         * @param string $type
         * @param string $message
         */
        public function add($type, $message);

        /**
         * Registers a message for a given type.
         *
         * @param string       $type
         * @param string|array $message
         */
        public function set($type, $message);

        /**
         * Gets flash messages for a given type.
         *
         * @param string $type    Message category type
         * @param array  $default Default value if $type does not exist
         *
         * @return array
         */
        public function peek($type, array $default = array());

        /**
         * Gets all flash messages.
         *
         * @return array
         */
        public function peekAll();

        /**
         * Gets and clears flash from the stack.
         *
         * @param string $type
         * @param array  $default Default value if $type does not exist
         *
         * @return array
         */
        public function get($type, array $default = array());

        /**
         * Gets and clears flashes from the stack.
         *
         * @return array
         */
        public function all();

        /**
         * Sets all flash messages.
         */
        public function setAll(array $messages);

        /**
         * Has flash messages for a given type?
         *
         * @param string $type
         *
         * @return bool
         */
        public function has($type);

        /**
         * Returns a list of all defined types.
         *
         * @return array
         */
        public function keys();
    }