system/libraries/drivers/Session.php

   1 <?php defined('SYSPATH') OR die('No direct access allowed.');
   2 /**
   3  * Session driver interface
   4  *
   5  * $Id: Session.php 3917 2009-01-21 03:06:22Z zombor $
   6  *
   7  * @package    Core
   8  * @author     Kohana Team
   9  * @copyright  (c) 2007-2008 Kohana Team
  10  * @license    http://kohanaphp.com/license.html
  11  */
  12 interface Session_Driver {
  13
  14         /**
  15          * Opens a session.
  16          *
  17          * @param   string   save path
  18          * @param   string   session name
  19          * @return  boolean
  20          */
  21         public function open($path, $name);
  22
  23         /**
  24          * Closes a session.
  25          *
  26          * @return  boolean
  27          */
  28         public function close();
  29
  30         /**
  31          * Reads a session.
  32          *
  33          * @param   string  session id
  34          * @return  string
  35          */
  36         public function read($id);
  37
  38         /**
  39          * Writes a session.
  40          *
  41          * @param   string   session id
  42          * @param   string   session data
  43          * @return  boolean
  44          */
  45         public function write($id, $data);
  46
  47         /**
  48          * Destroys a session.
  49          *
  50          * @param   string   session id
  51          * @return  boolean
  52          */
  53         public function destroy($id);
  54
  55         /**
  56          * Regenerates the session id.
  57          *
  58          * @return  string
  59          */
  60         public function regenerate();
  61
  62         /**
  63          * Garbage collection.
  64          *
  65          * @param   integer  session expiration period
  66          * @return  boolean
  67          */
  68         public function gc($maxlifetime);
  69
  70 } // End Session Driver Interface