class MemcachedSessionHandler in Zircon Profile 8

MemcachedSessionHandler.

Memcached based session storage handler based on the Memcached class provided by the PHP memcached extension.

@author Drak <[e-mail]>

Hierarchy

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

See also

http://php.net/memcached

1 file declares its use of MemcachedSessionHandler

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

File

vendor/symfony/http-foundation/Session/Storage/Handler/MemcachedSessionHandler.php, line 24

Namespace

Symfony\Component\HttpFoundation\Session\Storage\Handler

class MemcachedSessionHandler implements \SessionHandlerInterface {

  /**
   * @var \Memcached Memcached driver.
   */
  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 $memcached, array $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 open($savePath, $sessionName) {
    return true;
  }

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

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

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

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

  /**
   * {@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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MemcachedSessionHandler::$memcached	private	property
MemcachedSessionHandler::$prefix	private	property
MemcachedSessionHandler::$ttl	private	property
MemcachedSessionHandler::close	public	function
MemcachedSessionHandler::destroy	public	function
MemcachedSessionHandler::gc	public	function
MemcachedSessionHandler::getMemcached	protected	function	Return a Memcached instance.
MemcachedSessionHandler::open	public	function
MemcachedSessionHandler::read	public	function
MemcachedSessionHandler::write	public	function
MemcachedSessionHandler::__construct	public	function	Constructor.