toolkit

Ses

Low-level PHP session handling.

Use ->session in application code. The session is read once and its lock released at once (read_and_close), so a slow request never holds every other request of the same visitor. Each write reopens it, takes the lock just long enough to change the file and closes it again, reading what concurrent requests wrote in the meantime.

Ses:: Phlat\Toolkit\Ses 18 methods

Lifecycle 9

start Reads the session if this request hasn't yet. $options are session_start()'s, e.g. ['gc_maxlifetime' => 3600].
isStarted Whether this request has read the session - it may hold a flash message or the visitor's own state.
reads How many times session data was read or written so far.
isActive Whether the session is open for writing at this moment, holding its lock.
hasCookie Whether the request carries a session cookie, checkable without starting a session.
close Writes and closes the session if it is open, and forgets it was read, so the next start() reads it again.
id The session id.
regenerate Gives the session a new id, keeping its values.
destroy Ends the session and clears its values.

Data 6

get The value under $key, or null.
set Stores a value under $key.
ensure The value under $key, storing $value first when there is none.
has Whether a value is stored under $key.
delete Removes the value under $key.
all Every session value.

Flash 3

setFlash Stores a value for the next request only.
getFlash A flashed value, or null.
deleteFlash Removes a flashed value.

Lifecycle

start

Ses::start(array $options = []): void

Reads the session if this request hasn't yet. $options are session_start()'s, e.g. ['gc_maxlifetime' => 3600].

Parameters (1)

$options

array = []

phlat/src/Toolkit/Ses.php:27

isStarted

Ses::isStarted(): bool

Whether this request has read the session - it may hold a flash message or the visitor's own state.

Returns bool

phlat/src/Toolkit/Ses.php:39

reads

Ses::reads(): int

How many times session data was read or written so far.

A response that must not depend on the visitor compares it before and after rendering: starting the session just to learn there is no signed-in user (a stale cookie) reads nothing the output could show.

Returns int

phlat/src/Toolkit/Ses.php:49