Classes List

Symfony\Component\HttpFoundation\Session\Storage\Handler\MemcachedSessionHandler

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;

/** * Memcached based session storage handler based on the Memcached class * provided by the PHP memcached extension. * * @see http://php.net/memcached * * @author Drak <drak@zikula.org> */
class MemcachedSessionHandler extends AbstractSessionHandler
{
    private $memcached;

    /** * @var int Time to live in seconds */
    private $ttl;

    /** * @var string Key prefix for shared environments */
    private $prefix;

    /** * Constructor. * * List of available options: * * prefix: The prefix to use for the memcached keys in order to avoid collision * * expiretime: The time to live in seconds. * * @param \Memcached $memcached A \Memcached instance * @param array $options An associative array of Memcached options * * @throws \InvalidArgumentException When unsupported options are passed */
    public function __construct(\Memcached $memcachedarray $options = array())
    {
        $this->memcached = $memcached;

        if ($diff = array_diff(array_keys($options), array('prefix''expiretime'))) {
            throw new \InvalidArgumentException(sprintf(
                'The following options are not supported "%s"'implode(', '$diff)
            ));
        }

        $this->ttl = isset($options['expiretime']) ? (int) $options['expiretime'] : 86400;
        $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'sf2s';
    }

    /** * {@inheritdoc} */
    public function close()
    {
        return true;
    }

    /** * {@inheritdoc} */
    protected function doRead($sessionId)
    {
        return $this->memcached->get($this->prefix.$sessionId) ?: '';
    }

    /** * {@inheritdoc} */
    public function updateTimestamp($sessionId$data)
    {
        $this->memcached->touch($this->prefix.$sessionIdtime() + $this->ttl);

        return true;
    }

    /** * {@inheritdoc} */
    protected function doWrite($sessionId$data)
    {
        return $this->memcached->set($this->prefix.$sessionId$datatime() + $this->ttl);
    }

    /** * {@inheritdoc} */
    protected function doDestroy($sessionId)
    {
        $result = $this->memcached->delete($this->prefix.$sessionId);

        return $result || \Memcached::RES_NOTFOUND == $this->memcached->getResultCode();
    }

    /** * {@inheritdoc} */
    public function gc($maxlifetime)
    {
        // not required here because memcached will auto expire the records anyhow.
        return true;
    }

    /** * Return a Memcached instance. * * @return \Memcached */
    protected function getMemcached()
    {
        return $this->memcached;
    }
}