[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  /**
  13   * SessionHandlerInterface for PHP < 5.4.
  14   *
  15   * Extensive documentation can be found at php.net, see links:
  16   *
  17   * @see http://php.net/sessionhandlerinterface
  18   * @see http://php.net/session.customhandler
  19   * @see http://php.net/session-set-save-handler
  20   *
  21   * @author Drak <drak@zikula.org>
  22   */
  23  interface SessionHandlerInterface
  24  {
  25      /**
  26       * Re-initializes existing session, or creates a new one.
  27       *
  28       * @see http://php.net/sessionhandlerinterface.open
  29       *
  30       * @param string $savePath    Save path
  31       * @param string $sessionName Session name, see http://php.net/function.session-name.php
  32       *
  33       * @return bool true on success, false on failure
  34       */
  35      public function open($savePath, $sessionName);
  36  
  37      /**
  38       * Closes the current session.
  39       *
  40       * @see http://php.net/sessionhandlerinterface.close
  41       *
  42       * @return bool true on success, false on failure
  43       */
  44      public function close();
  45  
  46      /**
  47       * Reads the session data.
  48       *
  49       * @see http://php.net/sessionhandlerinterface.read
  50       *
  51       * @param string $sessionId Session ID, see http://php.net/function.session-id
  52       *
  53       * @return string Same session data as passed in write() or empty string when non-existent or on failure
  54       */
  55      public function read($sessionId);
  56  
  57      /**
  58       * Writes the session data to the storage.
  59       *
  60       * @see http://php.net/sessionhandlerinterface.write
  61       *
  62       * @param string $sessionId Session ID , see http://php.net/function.session-id
  63       * @param string $data      Serialized session data to save
  64       *
  65       * @return bool true on success, false on failure
  66       */
  67      public function write($sessionId, $data);
  68  
  69      /**
  70       * Destroys a session.
  71       *
  72       * @see http://php.net/sessionhandlerinterface.destroy
  73       *
  74       * @param string $sessionId Session ID, see http://php.net/function.session-id
  75       *
  76       * @return bool true on success, false on failure
  77       */
  78      public function destroy($sessionId);
  79  
  80      /**
  81       * Cleans up expired sessions (garbage collection).
  82       *
  83       * @see http://php.net/sessionhandlerinterface.gc
  84       *
  85       * @param string|int $maxlifetime Sessions that have not updated for the last maxlifetime seconds will be removed
  86       *
  87       * @return bool true on success, false on failure
  88       */
  89      public function gc($maxlifetime);
  90  }