\Symfony\Component\HttpFoundation\Session\Storage\HandlerRedisSessionHandler

Redis based session storage handler based on the Redis class provided by the PHP redis extension.

Summary

Methods
Properties
Constants
open()
validateId()
read()
write()
destroy()
__construct()
close()
gc()
updateTimestamp()
No public properties found
No constants found
doRead()
doWrite()
doDestroy()
No protected properties found
N/A
No private methods found
$sessionName
$prefetchId
$prefetchData
$newSessionId
$igbinaryEmptyData
$redis
$prefix
$ttl
N/A

Properties

$sessionName

$sessionName

$prefetchId

$prefetchId

$prefetchData

$prefetchData

$newSessionId

$newSessionId

$igbinaryEmptyData

$igbinaryEmptyData

$redis

$redis

$prefix

$prefix : string

Type

string — Key prefix for shared environments

$ttl

$ttl : int

Type

int — Time to live in seconds

Methods

open()

open(mixed  $savePath, mixed  $sessionName) : bool

Parameters

mixed $savePath
mixed $sessionName

Returns

bool —

validateId()

validateId(mixed  $sessionId) : bool

Parameters

mixed $sessionId

Returns

bool —

read()

read(mixed  $sessionId) : string

Parameters

mixed $sessionId

Returns

string —

write()

write(mixed  $sessionId, mixed  $data) : bool

Parameters

mixed $sessionId
mixed $data

Returns

bool —

destroy()

destroy(mixed  $sessionId) : bool

Parameters

mixed $sessionId

Returns

bool —

__construct()

__construct(\Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface|\Symfony\Component\Cache\Traits\RedisProxy|\Symfony\Component\Cache\Traits\RedisClusterProxy  $redis, array  $options = []) : mixed

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.

Parameters

\Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface|\Symfony\Component\Cache\Traits\RedisProxy|\Symfony\Component\Cache\Traits\RedisClusterProxy $redis
array $options

Throws

\InvalidArgumentException

When unsupported client or options are passed

Returns

mixed —

close()

close() : bool

{@inheritdoc}

Returns

bool —

gc()

gc(mixed  $maxlifetime) : int|false

{@inheritdoc}

Parameters

mixed $maxlifetime

Returns

int|false —

updateTimestamp()

updateTimestamp(mixed  $sessionId, mixed  $data) : bool

Parameters

mixed $sessionId
mixed $data

Returns

bool —

doRead()

doRead(string  $sessionId) : string

Parameters

string $sessionId

Returns

string —

doWrite()

doWrite(string  $sessionId, string  $data) : bool

Parameters

string $sessionId
string $data

Returns

bool —

doDestroy()

doDestroy(string  $sessionId) : bool

Parameters

string $sessionId

Returns

bool —