SessionStoreInterface
Tags
Table of Contents
Methods
- destroy() : bool
- Destroy a session.
- exists() : bool
- Check if a session exists.
- gc() : array<string|int, Uuid>
- Cleanup old sessions Sessions that have not updated for the configured TTL will be removed.
- read() : string|false
- Read session data.
- write() : bool
- Write session data.
Methods
destroy()
Destroy a session.
public
destroy(Uuid $id) : bool
Parameters
- $id : Uuid
-
The session ID being destroyed. The return value (usually TRUE on success, FALSE on failure).
Return values
boolexists()
Check if a session exists.
public
exists(Uuid $id) : bool
Parameters
- $id : Uuid
-
the session id
Return values
bool —true if the session exists, false otherwise
gc()
Cleanup old sessions Sessions that have not updated for the configured TTL will be removed.
public
gc() : array<string|int, Uuid>
Return values
array<string|int, Uuid>read()
Read session data.
public
read(Uuid $id) : string|false
Returns an encoded string of the read data. If nothing was read, it must return false.
Parameters
- $id : Uuid
-
the session id to read data for
Return values
string|falsewrite()
Write session data.
public
write(Uuid $id, string $data) : bool
Parameters
- $id : Uuid
-
the session id
- $data : string
-
the encoded session data