EncryptedStore
class EncryptedStore extends Store (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| 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 string | $serialization | The session store's serialization strategy. |
from Store |
| protected bool | $started | Session store started status. |
from Store |
| protected Encrypter | $encrypter | The encrypter instance. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new session instance.
Prepare the raw string data from the session for unserialization.
Marshal the ViewErrorBag when using JSON serialization for sessions.
Prepare the ViewErrorBag instance for JSON serialization.
Prepare the serialized session data for storage.
Get all the session data except for a specified array of items.
Determine if the given key is missing from the session data.
Determine if any of the given keys are present and not null.
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
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
void
__construct(string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string|null $id = null, string $serialization = 'php')
Create a new session instance.
in
Store at line 83
bool
start()
Start the session, reading the data from a handler.
in
Store at line 99
protected void
loadSession()
Load the session data from the handler.
in
Store at line 111
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 144
protected void
marshalErrorBag()
Marshal the ViewErrorBag when using JSON serialization for sessions.
in
Store at line 166
void
save()
Save the session data to storage.
in
Store at line 184
protected void
prepareErrorBagForSerialization()
Prepare the ViewErrorBag instance for JSON serialization.
protected string
prepareForStorage(string $data)
Prepare the serialized session data for storage.
in
Store at line 218
void
ageFlashData()
Age the flash data for the session.
in
Store at line 232
array
all()
Get all of the session data.
in
Store at line 243
array
only(array $keys)
Get a subset of the session data.
in
Store at line 254
array
except(array $keys)
Get all the session data except for a specified array of items.
in
Store at line 265
bool
exists(string|array $key)
Checks if a key exists.
in
Store at line 280
bool
missing(string|array $key)
Determine if the given key is missing from the session data.
in
Store at line 291
bool
has(string|array $key)
Determine if a key is present and not null.
in
Store at line 304
bool
hasAny(string|array $key)
Determine if any of the given keys are present and not null.
in
Store at line 318
mixed
get(string $key, mixed $default = null)
Get an item from the session.
in
Store at line 330
mixed
pull(string $key, mixed $default = null)
Get the value of a given key and then forget it.
in
Store at line 341
bool
hasOldInput(string|null $key = null)
Determine if the session contains old input.
in
Store at line 355
mixed
getOldInput(string|null $key = null, mixed $default = null)
Get the requested item from the flashed input array.
in
Store at line 366
void
replace(array $attributes)
Replace the given session attributes entirely.
in
Store at line 378
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 396
mixed
remember(string $key, Closure $callback)
Get an item from the session, or store the default value.
in
Store at line 414
void
push(string $key, mixed $value)
Push a value onto a session array.
in
Store at line 430
mixed
increment(string $key, int $amount = 1)
Increment the value of an item in the session.
in
Store at line 444
int
decrement(string $key, int $amount = 1)
Decrement the value of an item in the session.
in
Store at line 456
void
flash(string $key, mixed $value = true)
Flash a key / value pair to the session.
in
Store at line 472
void
now(string $key, mixed $value)
Flash a key / value pair to the session for immediate use.
in
Store at line 484
void
reflash()
Reflash all of the session flash data.
in
Store at line 497
void
keep(array|mixed $keys = null)
Reflash a subset of the current flash data.
in
Store at line 510
protected void
mergeNewFlashes(array $keys)
Merge new flash keys into the new flash array.
in
Store at line 523
protected void
removeFromOldFlashData(array $keys)
Remove the given keys from the old flash data.
in
Store at line 534
void
flashInput(array $value)
Flash an input array to the session.
in
Store at line 545
mixed
remove(string $key)
Remove an item from the session, returning its value.
in
Store at line 556
void
forget(string|array $keys)
Remove one or many items from the session.
in
Store at line 566
void
flush()
Remove all of the items from the session.
in
Store at line 576
bool
invalidate()
Flush the session data and regenerate the ID.
in
Store at line 589
bool
regenerate(bool $destroy = false)
Generate a new session identifier.
in
Store at line 602
bool
migrate(bool $destroy = false)
Generate a new session ID for the session.
in
Store at line 620
bool
isStarted()
Determine if the session has been started.
in
Store at line 630
string
getName()
Get the name of the session.
in
Store at line 641
void
setName(string $name)
Set the name of the session.
in
Store at line 651
string
id()
Get the current session ID.
in
Store at line 661
string
getId()
Get the current session ID.
in
Store at line 672
void
setId(string $id)
Set the session ID.
in
Store at line 683
bool
isValidId(string|null $id)
Determine if this is a valid session ID.
in
Store at line 693
protected string
generateSessionId()
Get a new, random session ID.
in
Store at line 704
void
setExists(bool $value)
Set the existence of the session on the handler if applicable.
in
Store at line 716
string
token()
Get the CSRF token value.
in
Store at line 726
void
regenerateToken()
Regenerate the CSRF token value.
in
Store at line 736
string|null
previousUrl()
Get the previous URL from the session.
in
Store at line 747
void
setPreviousUrl(string $url)
Set the "previous" URL in the session.
in
Store at line 757
void
passwordConfirmed()
Specify that the user has confirmed their password.
in
Store at line 767
SessionHandlerInterface
getHandler()
Get the underlying session handler implementation.
in
Store at line 778
SessionHandlerInterface
setHandler(SessionHandlerInterface $handler)
Set the underlying session handler implementation.
in
Store at line 788
bool
handlerNeedsRequest()
Determine if the session handler needs a request.
in
Store at line 799
void
setRequestOnHandler(Request $request)
Set the request on the handler instance.
Encrypter
getEncrypter()
Get the encrypter instance.