www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-foundation/Session/Storage/Handler/MemcacheSessionHandler.php

   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 namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;
  13
  14 @trigger_error(sprintf('The class %s is deprecated since Symfony 3.4 and will be removed in 4.0. Use Symfony\Component\HttpFoundation\Session\Storage\Handler\MemcachedSessionHandler instead.', MemcacheSessionHandler::class), E_USER_DEPRECATED);
  15
  16 /**
  17  * @author Drak <drak@zikula.org>
  18  *
  19  * @deprecated since version 3.4, to be removed in 4.0. Use Symfony\Component\HttpFoundation\Session\Storage\Handler\MemcachedSessionHandler instead.
  20  */
  21 class MemcacheSessionHandler implements \SessionHandlerInterface
  22 {
  23     private $memcache;
  24
  25     /**
  26      * @var int Time to live in seconds
  27      */
  28     private $ttl;
  29
  30     /**
  31      * @var string Key prefix for shared environments
  32      */
  33     private $prefix;
  34
  35     /**
  36      * Constructor.
  37      *
  38      * List of available options:
  39      *  * prefix: The prefix to use for the memcache keys in order to avoid collision
  40      *  * expiretime: The time to live in seconds
  41      *
  42      * @param \Memcache $memcache A \Memcache instance
  43      * @param array     $options  An associative array of Memcache options
  44      *
  45      * @throws \InvalidArgumentException When unsupported options are passed
  46      */
  47     public function __construct(\Memcache $memcache, array $options = array())
  48     {
  49         if ($diff = array_diff(array_keys($options), array('prefix', 'expiretime'))) {
  50             throw new \InvalidArgumentException(sprintf(
  51                 'The following options are not supported "%s"', implode(', ', $diff)
  52             ));
  53         }
  54
  55         $this->memcache = $memcache;
  56         $this->ttl = isset($options['expiretime']) ? (int) $options['expiretime'] : 86400;
  57         $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'sf2s';
  58     }
  59
  60     /**
  61      * {@inheritdoc}
  62      */
  63     public function open($savePath, $sessionName)
  64     {
  65         return true;
  66     }
  67
  68     /**
  69      * {@inheritdoc}
  70      */
  71     public function close()
  72     {
  73         return true;
  74     }
  75
  76     /**
  77      * {@inheritdoc}
  78      */
  79     public function read($sessionId)
  80     {
  81         return $this->memcache->get($this->prefix.$sessionId) ?: '';
  82     }
  83
  84     /**
  85      * {@inheritdoc}
  86      */
  87     public function write($sessionId, $data)
  88     {
  89         return $this->memcache->set($this->prefix.$sessionId, $data, 0, time() + $this->ttl);
  90     }
  91
  92     /**
  93      * {@inheritdoc}
  94      */
  95     public function destroy($sessionId)
  96     {
  97         $this->memcache->delete($this->prefix.$sessionId);
  98
  99         return true;
 100     }
 101
 102     /**
 103      * {@inheritdoc}
 104      */
 105     public function gc($maxlifetime)
 106     {
 107         // not required here because memcache will auto expire the records anyhow.
 108         return true;
 109     }
 110
 111     /**
 112      * Return a Memcache instance.
 113      *
 114      * @return \Memcache
 115      */
 116     protected function getMemcache()
 117     {
 118         return $this->memcache;
 119     }
 120 }