[Summary view] [Print] [Text view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Session handler base.
  19   *
  20   * @package    core
  21   * @copyright  2013 Petr Skoda {@link http://skodak.org}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\session;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Session handler base.
  31   *
  32   * @package    core
  33   * @copyright  2013 Petr Skoda {@link http://skodak.org}
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  abstract class handler {
  37      /**
  38       * Start the session.
  39       * @return bool success
  40       */
  41      public function start() {
  42          return session_start();
  43      }
  44  
  45      /**
  46       * Init session handler.
  47       */
  48      public abstract function init();
  49  
  50      /**
  51       * Check the backend contains data for this session id.
  52       *
  53       * Note: this is intended to be called from manager::session_exists() only.
  54       *
  55       * @param string $sid
  56       * @return bool true if session found.
  57       */
  58      public abstract function session_exists($sid);
  59  
  60      /**
  61       * Kill all active sessions, the core sessions table is
  62       * purged afterwards.
  63       */
  64      public abstract function kill_all_sessions();
  65  
  66      /**
  67       * Kill one session, the session record is removed afterwards.
  68       * @param string $sid
  69       */
  70      public abstract function kill_session($sid);
  71  }