EncryptedStore
class EncryptedStore extends Store (View source)
Properties
| protected string | $id | The session ID. |
from Store |
| protected string | $name | The session name. |
from Store |
| protected array | $attributes | The session attributes. |
from Store |
| protected SessionHandlerInterface | $handler | The session handler implementation. |
from Store |
| protected bool | $started | Session store started status. |
from Store |
| protected Encrypter | $encrypter | The encrypter instance. |
Methods
Create a new session instance.
Prepare the raw string data from the session for unserialization.
Prepare the serialized session data for storage.
Get the value of a given key and then forget it.
Get the requested item from the flashed input array.
Put a key / value pair or array of key / value pairs in the session.
Increment the value of an item in the session.
Decrement the value of an item in the session.
Flash a key / value pair to the session for immediate use.
Set the existence of the session on the handler if applicable.
Get the encrypter instance.
Details
void
__construct(string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string|null $id = null)
Create a new session instance.
in
Store at line 68
bool
start()
Start the session, reading the data from a handler.
in
Store at line 84
protected void
loadSession()
Load the session data from the handler.
in
Store at line 94
protected array
readFromHandler()
Read the session data from the handler.
protected string
prepareForUnserialize(string $data)
Prepare the raw string data from the session for unserialization.
in
Store at line 123
bool
save()
Save the session data to storage.
protected string
prepareForStorage(string $data)
Prepare the serialized session data for storage.
in
Store at line 150
void
ageFlashData()
Age the flash data for the session.
in
Store at line 164
array
all()
Get all of the session data.
in
Store at line 175
bool
exists(string|array $key)
Checks if a key exists.
in
Store at line 188
bool
has(string|array $key)
Checks if a key is present and not null.
in
Store at line 202
mixed
get(string $key, mixed $default = null)
Get an item from the session.
in
Store at line 214
mixed
pull(string $key, string $default = null)
Get the value of a given key and then forget it.
in
Store at line 225
bool
hasOldInput(string $key = null)
Determine if the session contains old input.
in
Store at line 239
mixed
getOldInput(string $key = null, mixed $default = null)
Get the requested item from the flashed input array.
in
Store at line 250
void
replace(array $attributes)
Replace the given session attributes entirely.
in
Store at line 262
void
put(string|array $key, mixed $value = null)
Put a key / value pair or array of key / value pairs in the session.
in
Store at line 280
mixed
remember(string $key, Closure $callback)
Get an item from the session, or store the default value.
in
Store at line 298
void
push(string $key, mixed $value)
Push a value onto a session array.
in
Store at line 314
mixed
increment(string $key, int $amount = 1)
Increment the value of an item in the session.
in
Store at line 328
int
decrement(string $key, int $amount = 1)
Decrement the value of an item in the session.
in
Store at line 340
void
flash(string $key, mixed $value = true)
Flash a key / value pair to the session.
in
Store at line 356
void
now(string $key, mixed $value)
Flash a key / value pair to the session for immediate use.
in
Store at line 368
void
reflash()
Reflash all of the session flash data.
in
Store at line 381
void
keep(array|mixed $keys = null)
Reflash a subset of the current flash data.
in
Store at line 394
protected void
mergeNewFlashes(array $keys)
Merge new flash keys into the new flash array.
in
Store at line 407
protected void
removeFromOldFlashData(array $keys)
Remove the given keys from the old flash data.
in
Store at line 418
void
flashInput(array $value)
Flash an input array to the session.
in
Store at line 429
mixed
remove(string $key)
Remove an item from the session, returning its value.
in
Store at line 440
void
forget(string|array $keys)
Remove one or many items from the session.
in
Store at line 450
void
flush()
Remove all of the items from the session.
in
Store at line 460
bool
invalidate()
Flush the session data and regenerate the ID.
in
Store at line 473
bool
regenerate(bool $destroy = false)
Generate a new session identifier.
in
Store at line 484
bool
migrate(bool $destroy = false)
Generate a new session ID for the session.
in
Store at line 502
bool
isStarted()
Determine if the session has been started.
in
Store at line 512
string
getName()
Get the name of the session.
in
Store at line 523
void
setName(string $name)
Set the name of the session.
in
Store at line 533
string
getId()
Get the current session ID.
in
Store at line 544
void
setId(string $id)
Set the session ID.
in
Store at line 555
bool
isValidId(string $id)
Determine if this is a valid session ID.
in
Store at line 565
protected string
generateSessionId()
Get a new, random session ID.
in
Store at line 576
void
setExists(bool $value)
Set the existence of the session on the handler if applicable.
in
Store at line 588
string
token()
Get the CSRF token value.
in
Store at line 598
void
regenerateToken()
Regenerate the CSRF token value.
in
Store at line 608
string|null
previousUrl()
Get the previous URL from the session.
in
Store at line 619
void
setPreviousUrl(string $url)
Set the "previous" URL in the session.
in
Store at line 629
SessionHandlerInterface
getHandler()
Get the underlying session handler implementation.
in
Store at line 639
bool
handlerNeedsRequest()
Determine if the session handler needs a request.
in
Store at line 650
void
setRequestOnHandler(Request $request)
Set the request on the handler instance.
Encrypter
getEncrypter()
Get the encrypter instance.