class MemcacheSessionHandler in Zircon Profile 8

MemcacheSessionHandler.

@author Drak <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpFoundation\Session\Storage\Handler\MemcacheSessionHandler implements \Symfony\Component\HttpFoundation\Session\Storage\Handler\SessionHandlerInterface

1 file declares its use of MemcacheSessionHandler

MemcacheSessionHandlerTest.php in vendor/symfony/http-foundation/Tests/Session/Storage/Handler/MemcacheSessionHandlerTest.php

File

vendor/symfony/http-foundation/Session/Storage/Handler/MemcacheSessionHandler.php, line 19

Namespace

Symfony\Component\HttpFoundation\Session\Storage\Handler

class MemcacheSessionHandler implements \SessionHandlerInterface {

  /**
   * @var \Memcache Memcache driver.
   */
  private $memcache;

  /**
   * @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 memcache keys in order to avoid collision
   *  * expiretime: The time to live in seconds
   *
   * @param \Memcache $memcache A \Memcache instance
   * @param array     $options  An associative array of Memcache options
   *
   * @throws \InvalidArgumentException When unsupported options are passed
   */
  public function __construct(\Memcache $memcache, array $options = array()) {
    if ($diff = array_diff(array_keys($options), array(
      'prefix',
      'expiretime',
    ))) {
      throw new \InvalidArgumentException(sprintf('The following options are not supported "%s"', implode(', ', $diff)));
    }
    $this->memcache = $memcache;
    $this->ttl = isset($options['expiretime']) ? (int) $options['expiretime'] : 86400;
    $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'sf2s';
  }

  /**
   * {@inheritdoc}
   */
  public function open($savePath, $sessionName) {
    return true;
  }

  /**
   * {@inheritdoc}
   */
  public function close() {
    return $this->memcache
      ->close();
  }

  /**
   * {@inheritdoc}
   */
  public function read($sessionId) {
    return $this->memcache
      ->get($this->prefix . $sessionId) ?: '';
  }

  /**
   * {@inheritdoc}
   */
  public function write($sessionId, $data) {
    return $this->memcache
      ->set($this->prefix . $sessionId, $data, 0, time() + $this->ttl);
  }

  /**
   * {@inheritdoc}
   */
  public function destroy($sessionId) {
    return $this->memcache
      ->delete($this->prefix . $sessionId);
  }

  /**
   * {@inheritdoc}
   */
  public function gc($maxlifetime) {

    // not required here because memcache will auto expire the records anyhow.
    return true;
  }

  /**
   * Return a Memcache instance.
   *
   * @return \Memcache
   */
  protected function getMemcache() {
    return $this->memcache;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MemcacheSessionHandler::$memcache	private	property
MemcacheSessionHandler::$prefix	private	property
MemcacheSessionHandler::$ttl	private	property
MemcacheSessionHandler::close	public	function
MemcacheSessionHandler::destroy	public	function
MemcacheSessionHandler::gc	public	function
MemcacheSessionHandler::getMemcache	protected	function	Return a Memcache instance.
MemcacheSessionHandler::open	public	function
MemcacheSessionHandler::read	public	function
MemcacheSessionHandler::write	public	function
MemcacheSessionHandler::__construct	public	function	Constructor.