interface/modules/zend_modules/library/Zend/Session/SaveHandler/Cache.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 use Zend\Cache\Storage\ClearExpiredInterface as ClearExpiredCacheStorage;
  13 use Zend\Cache\Storage\StorageInterface as CacheStorage;
  14
  15 /**
  16  * Cache session save handler
  17  */
  18 class Cache implements SaveHandlerInterface
  19 {
  20     /**
  21      * Session Save Path
  22      *
  23      * @var string
  24      */
  25     protected $sessionSavePath;
  26
  27     /**
  28      * Session Name
  29      *
  30      * @var string
  31      */
  32     protected $sessionName;
  33
  34     /**
  35      * The cache storage
  36      * @var CacheStorage
  37      */
  38     protected $cacheStorage;
  39
  40     /**
  41      * Constructor
  42      *
  43      * @param  CacheStorage $cacheStorage
  44      */
  45     public function __construct(CacheStorage $cacheStorage)
  46     {
  47         $this->setCacheStorage($cacheStorage);
  48     }
  49
  50     /**
  51      * Open Session
  52      *
  53      * @param string $savePath
  54      * @param string $name
  55      * @return bool
  56      */
  57     public function open($savePath, $name)
  58     {
  59         // @todo figure out if we want to use these
  60         $this->sessionSavePath = $savePath;
  61         $this->sessionName     = $name;
  62
  63         return true;
  64     }
  65
  66     /**
  67      * Close session
  68      *
  69      * @return bool
  70      */
  71     public function close()
  72     {
  73         return true;
  74     }
  75
  76     /**
  77      * Read session data
  78      *
  79      * @param string $id
  80      * @return string
  81      */
  82     public function read($id)
  83     {
  84         return $this->getCacheStorage()->getItem($id);
  85     }
  86
  87     /**
  88      * Write session data
  89      *
  90      * @param string $id
  91      * @param string $data
  92      * @return bool
  93      */
  94     public function write($id, $data)
  95     {
  96         return $this->getCacheStorage()->setItem($id, $data);
  97     }
  98
  99     /**
 100      * Destroy session
 101      *
 102      * @param string $id
 103      * @return bool
 104      */
 105     public function destroy($id)
 106     {
 107         return $this->getCacheStorage()->removeItem($id);
 108     }
 109
 110     /**
 111      * Garbage Collection
 112      *
 113      * @param int $maxlifetime
 114      * @return bool
 115      */
 116     public function gc($maxlifetime)
 117     {
 118         $cache = $this->getCacheStorage();
 119         if ($cache instanceof ClearExpiredCacheStorage) {
 120             return $cache->clearExpired();
 121         }
 122         return true;
 123     }
 124
 125     /**
 126      * Set cache storage
 127      *
 128      * @param  CacheStorage $cacheStorage
 129      * @return Cache
 130      */
 131     public function setCacheStorage(CacheStorage $cacheStorage)
 132     {
 133         $this->cacheStorage = $cacheStorage;
 134         return $this;
 135     }
 136
 137     /**
 138      * Get cache storage
 139      *
 140      * @return CacheStorage
 141      */
 142     public function getCacheStorage()
 143     {
 144         return $this->cacheStorage;
 145     }
 146
 147     /**
 148      * @deprecated Misspelled method - use getCacheStorage() instead
 149      */
 150     public function getCacheStorge()
 151     {
 152         return $this->getCacheStorage();
 153     }
 154 }