class RedisSessionHandler
Redis based session storage handler based on the Redis class provided by the PHP redis extension.
@author Dalibor Karlović <dalibor@flexolabs.io>
Hierarchy
- class \Symfony\Component\HttpFoundation\Session\Storage\Handler\AbstractSessionHandler implements \Symfony\Component\HttpFoundation\Session\Storage\Handler\SessionHandlerInterface, \Symfony\Component\HttpFoundation\Session\Storage\Handler\SessionUpdateTimestampHandlerInterface
- class \Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler extends \Symfony\Component\HttpFoundation\Session\Storage\Handler\AbstractSessionHandler
Expanded class hierarchy of RedisSessionHandler
File
-
vendor/
symfony/ http-foundation/ Session/ Storage/ Handler/ RedisSessionHandler.php, line 23
Namespace
Symfony\Component\HttpFoundation\Session\Storage\HandlerView source
class RedisSessionHandler extends AbstractSessionHandler {
/**
* Key prefix for shared environments.
*/
private string $prefix;
/**
* Time to live in seconds.
*/
private int|\Closure|null $ttl;
/**
* List of available options:
* * prefix: The prefix to use for the keys in order to avoid collision on the Redis server
* * ttl: The time to live in seconds.
*
* @throws \InvalidArgumentException When unsupported client or options are passed
*/
public function __construct(\Redis|Relay|\RedisArray|\RedisCluster|\Predis\ClientInterface $redis, array $options = []) {
if ($diff = array_diff(array_keys($options), [
'prefix',
'ttl',
])) {
throw new \InvalidArgumentException(\sprintf('The following options are not supported "%s".', implode(', ', $diff)));
}
$this->prefix = $options['prefix'] ?? 'sf_s';
$this->ttl = $options['ttl'] ?? null;
}
protected function doRead(string $sessionId) : string {
return $this->redis
->get($this->prefix . $sessionId) ?: '';
}
protected function doWrite(string $sessionId, string $data) : bool {
$ttl = ($this->ttl instanceof \Closure ? ($this->ttl)() : $this->ttl) ?? \ini_get('session.gc_maxlifetime');
$result = $this->redis
->setEx($this->prefix . $sessionId, (int) $ttl, $data);
return $result && !$result instanceof ErrorInterface;
}
protected function doDestroy(string $sessionId) : bool {
static $unlink = true;
if ($unlink) {
try {
$unlink = false !== $this->redis
->unlink($this->prefix . $sessionId);
} catch (\Throwable) {
$unlink = false;
}
}
if (!$unlink) {
$this->redis
->del($this->prefix . $sessionId);
}
return true;
}
public function close() : bool {
return true;
}
public function gc(int $maxlifetime) : int|false {
return 0;
}
public function updateTimestamp(string $sessionId, string $data) : bool {
$ttl = ($this->ttl instanceof \Closure ? ($this->ttl)() : $this->ttl) ?? \ini_get('session.gc_maxlifetime');
return $this->redis
->expire($this->prefix . $sessionId, (int) $ttl);
}
}