interface/modules/zend_modules/library/Zend/Session/SaveHandler/SaveHandlerInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Session\SaveHandler;
  11
  12 /**
  13  * SaveHandler Interface
  14  *
  15  * @see        http://php.net/session_set_save_handler
  16  */
  17 interface SaveHandlerInterface
  18 {
  19     /**
  20      * Open Session - retrieve resources
  21      *
  22      * @param string $savePath
  23      * @param string $name
  24      */
  25     public function open($savePath, $name);
  26
  27     /**
  28      * Close Session - free resources
  29      *
  30      */
  31     public function close();
  32
  33     /**
  34      * Read session data
  35      *
  36      * @param string $id
  37      */
  38     public function read($id);
  39
  40     /**
  41      * Write Session - commit data to resource
  42      *
  43      * @param string $id
  44      * @param mixed $data
  45      */
  46     public function write($id, $data);
  47
  48     /**
  49      * Destroy Session - remove data from resource for
  50      * given session id
  51      *
  52      * @param string $id
  53      */
  54     public function destroy($id);
  55
  56     /**
  57      * Garbage Collection - remove old session data older
  58      * than $maxlifetime (in seconds)
  59      *
  60      * @param int $maxlifetime
  61      */
  62     public function gc($maxlifetime);
  63 }