[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <fabien@symfony.com>
   7   *
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  namespace Symfony\Component\HttpFoundation\Session;
  13  
  14  /**
  15   * Session Bag store.
  16   *
  17   * @author Drak <drak@zikula.org>
  18   */
  19  interface SessionBagInterface
  20  {
  21      /**
  22       * Gets this bag's name.
  23       *
  24       * @return string
  25       */
  26      public function getName();
  27  
  28      /**
  29       * Initializes the Bag.
  30       *
  31       * @param array $array
  32       */
  33      public function initialize(array &$array);
  34  
  35      /**
  36       * Gets the storage key for this bag.
  37       *
  38       * @return string
  39       */
  40      public function getStorageKey();
  41  
  42      /**
  43       * Clears out data from bag.
  44       *
  45       * @return mixed Whatever data was contained.
  46       */
  47      public function clear();
  48  }