# SessionBagInterface

interface SessionBagInterface

Session Bag store.

## Methods

`public` | `string` | `getName()` | Gets this bag's name. |
`public` | `` | `initialize(array $array)` | Initializes the Bag. |
`public` | `string` | `getStorageKey()` | Gets the storage key for this bag. |
`public` | `mixed` | `clear()` | Clears out data from bag. |

## Details

at line 26

### `getName()`

`public string getName()`

Gets this bag's name.

#### Return Value

`string` |

at line 31

### `initialize()`

`public initialize(array $array)`

Initializes the Bag.

#### Parameters

`array` | `$array` |

at line 38

### `getStorageKey()`

`public string getStorageKey()`

Gets the storage key for this bag.

#### Return Value

`string` |

at line 45

### `clear()`

`public mixed clear()`

Clears out data from bag.

#### Return Value

`mixed` | Whatever data was contained

## 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;

    /**
     * Session Bag store.
     *
     * @author Drak <drak@zikula.org>
     */
    interface SessionBagInterface
    {
        /**
         * Gets this bag's name.
         *
         * @return string
         */
        public function getName();

        /**
         * Initializes the Bag.
         */
        public function initialize(array &$array);

        /**
         * Gets the storage key for this bag.
         *
         * @return string
         */
        public function getStorageKey();

        /**
         * Clears out data from bag.
         *
         * @return mixed Whatever data was contained
         */
        public function clear();
    }