1. class
  2. Illuminate
  3. \
  4. Session
  5. \
  6. EncryptedStore

EncryptedStore

class EncryptedStore extends Store (View source)

Traits

Macroable

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

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string|null $id = null, string $serialization = 'php')

Create a new session instance.

bool
start()

Start the session, reading the data from a handler.

from  Store
void
loadSession()

Load the session data from the handler.

from  Store
array
readFromHandler()

Read the session data from the handler.

from  Store
string
prepareForUnserialize(string $data)

Prepare the raw string data from the session for unserialization.

void
marshalErrorBag()

Marshal the ViewErrorBag when using JSON serialization for sessions.

from  Store
void
save()

Save the session data to storage.

from  Store
void
prepareErrorBagForSerialization()

Prepare the ViewErrorBag instance for JSON serialization.

from  Store
string
prepareForStorage(string $data)

Prepare the serialized session data for storage.

void
ageFlashData()

Age the flash data for the session.

from  Store
array
all()

Get all of the session data.

from  Store
array
only(array $keys)

Get a subset of the session data.

from  Store
array
except(array $keys)

Get all the session data except for a specified array of items.

from  Store
bool
exists(string|array $key)

Checks if a key exists.

from  Store
bool
missing(string|array $key)

Determine if the given key is missing from the session data.

from  Store
bool
has(string|array $key)

Determine if a key is present and not null.

from  Store
bool
hasAny(string|array $key)

Determine if any of the given keys are present and not null.

from  Store
mixed
get(string $key, mixed $default = null)

Get an item from the session.

from  Store
mixed
pull(string $key, mixed $default = null)

Get the value of a given key and then forget it.

from  Store
bool
hasOldInput(string|null $key = null)

Determine if the session contains old input.

from  Store
mixed
getOldInput(string|null $key = null, mixed $default = null)

Get the requested item from the flashed input array.

from  Store
void
replace(array $attributes)

Replace the given session attributes entirely.

from  Store
void
put(string|array $key, mixed $value = null)

Put a key / value pair or array of key / value pairs in the session.

from  Store
mixed
remember(string $key, Closure $callback)

Get an item from the session, or store the default value.

from  Store
void
push(string $key, mixed $value)

Push a value onto a session array.

from  Store
mixed
increment(string $key, int $amount = 1)

Increment the value of an item in the session.

from  Store
int
decrement(string $key, int $amount = 1)

Decrement the value of an item in the session.

from  Store
void
flash(string $key, mixed $value = true)

Flash a key / value pair to the session.

from  Store
void
now(string $key, mixed $value)

Flash a key / value pair to the session for immediate use.

from  Store
void
reflash()

Reflash all of the session flash data.

from  Store
void
keep(array|mixed $keys = null)

Reflash a subset of the current flash data.

from  Store
void
mergeNewFlashes(array $keys)

Merge new flash keys into the new flash array.

from  Store
void
removeFromOldFlashData(array $keys)

Remove the given keys from the old flash data.

from  Store
void
flashInput(array $value)

Flash an input array to the session.

from  Store
mixed
remove(string $key)

Remove an item from the session, returning its value.

from  Store
void
forget(string|array $keys)

Remove one or many items from the session.

from  Store
void
flush()

Remove all of the items from the session.

from  Store
bool
invalidate()

Flush the session data and regenerate the ID.

from  Store
bool
regenerate(bool $destroy = false)

Generate a new session identifier.

from  Store
bool
migrate(bool $destroy = false)

Generate a new session ID for the session.

from  Store
bool
isStarted()

Determine if the session has been started.

from  Store
string
getName()

Get the name of the session.

from  Store
void
setName(string $name)

Set the name of the session.

from  Store
string
id()

Get the current session ID.

from  Store
string
getId()

Get the current session ID.

from  Store
void
setId(string $id)

Set the session ID.

from  Store
bool
isValidId(string|null $id)

Determine if this is a valid session ID.

from  Store
string
generateSessionId()

Get a new, random session ID.

from  Store
void
setExists(bool $value)

Set the existence of the session on the handler if applicable.

from  Store
string
token()

Get the CSRF token value.

from  Store
void
regenerateToken()

Regenerate the CSRF token value.

from  Store
bool
hasPreviousUri()

Determine if the previous URI is available.

from  Store
Uri
previousUri()

Get the previous URL from the session as a URI instance.

from  Store
string|null
previousUrl()

Get the previous URL from the session.

from  Store
void
setPreviousUrl(string $url)

Set the "previous" URL in the session.

from  Store
void
passwordConfirmed()

Specify that the user has confirmed their password.

from  Store
SessionHandlerInterface
getHandler()

Get the underlying session handler implementation.

from  Store
SessionHandlerInterface
setHandler(SessionHandlerInterface $handler)

Set the underlying session handler implementation.

from  Store
bool
handlerNeedsRequest()

Determine if the session handler needs a request.

from  Store
void
setRequestOnHandler(Request $request)

Set the request on the handler instance.

from  Store
Encrypter
getEncrypter()

Get the encrypter instance.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 27
__construct(string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string|null $id = null, string $serialization = 'php')

Create a new session instance.

Parameters

string $name
SessionHandlerInterface $handler
Encrypter $encrypter
string|null $id
string $serialization

in Store at line 86
bool start()

Start the session, reading the data from a handler.

Return Value

bool

in Store at line 102
protected void loadSession()

Load the session data from the handler.

Return Value

void

in Store at line 114
protected array readFromHandler()

Read the session data from the handler.

Return Value

array

at line 40
protected string prepareForUnserialize(string $data)

Prepare the raw string data from the session for unserialization.

Parameters

string $data

Return Value

string

in Store at line 147
protected void marshalErrorBag()

Marshal the ViewErrorBag when using JSON serialization for sessions.

Return Value

void

in Store at line 169
void save()

Save the session data to storage.

Return Value

void

in Store at line 187
protected void prepareErrorBagForSerialization()

Prepare the ViewErrorBag instance for JSON serialization.

Return Value

void

at line 55
protected string prepareForStorage(string $data)

Prepare the serialized session data for storage.

Parameters

string $data

Return Value

string

in Store at line 221
void ageFlashData()

Age the flash data for the session.

Return Value

void

in Store at line 235
array all()

Get all of the session data.

Return Value

array

in Store at line 246
array only(array $keys)

Get a subset of the session data.

Parameters

array $keys

Return Value

array

in Store at line 257
array except(array $keys)

Get all the session data except for a specified array of items.

Parameters

array $keys

Return Value

array

in Store at line 268
bool exists(string|array $key)

Checks if a key exists.

Parameters

string|array $key

Return Value

bool

in Store at line 283
bool missing(string|array $key)

Determine if the given key is missing from the session data.

Parameters

string|array $key

Return Value

bool

in Store at line 294
bool has(string|array $key)

Determine if a key is present and not null.

Parameters

string|array $key

Return Value

bool

in Store at line 307
bool hasAny(string|array $key)

Determine if any of the given keys are present and not null.

Parameters

string|array $key

Return Value

bool

in Store at line 321
mixed get(string $key, mixed $default = null)

Get an item from the session.

Parameters

string $key
mixed $default

Return Value

mixed

in Store at line 333
mixed pull(string $key, mixed $default = null)

Get the value of a given key and then forget it.

Parameters

string $key
mixed $default

Return Value

mixed

in Store at line 344
bool hasOldInput(string|null $key = null)

Determine if the session contains old input.

Parameters

string|null $key

Return Value

bool

in Store at line 358
mixed getOldInput(string|null $key = null, mixed $default = null)

Get the requested item from the flashed input array.

Parameters

string|null $key
mixed $default

Return Value

mixed

in Store at line 369
void replace(array $attributes)

Replace the given session attributes entirely.

Parameters

array $attributes

Return Value

void

in Store at line 381
void put(string|array $key, mixed $value = null)

Put a key / value pair or array of key / value pairs in the session.

Parameters

string|array $key
mixed $value

Return Value

void

in Store at line 399
mixed remember(string $key, Closure $callback)

Get an item from the session, or store the default value.

Parameters

string $key
Closure $callback

Return Value

mixed

in Store at line 417
void push(string $key, mixed $value)

Push a value onto a session array.

Parameters

string $key
mixed $value

Return Value

void

in Store at line 433
mixed increment(string $key, int $amount = 1)

Increment the value of an item in the session.

Parameters

string $key
int $amount

Return Value

mixed

in Store at line 447
int decrement(string $key, int $amount = 1)

Decrement the value of an item in the session.

Parameters

string $key
int $amount

Return Value

int

in Store at line 459
void flash(string $key, mixed $value = true)

Flash a key / value pair to the session.

Parameters

string $key
mixed $value

Return Value

void

in Store at line 475
void now(string $key, mixed $value)

Flash a key / value pair to the session for immediate use.

Parameters

string $key
mixed $value

Return Value

void

in Store at line 487
void reflash()

Reflash all of the session flash data.

Return Value

void

in Store at line 500
void keep(array|mixed $keys = null)

Reflash a subset of the current flash data.

Parameters

array|mixed $keys

Return Value

void

in Store at line 513
protected void mergeNewFlashes(array $keys)

Merge new flash keys into the new flash array.

Parameters

array $keys

Return Value

void

in Store at line 526
protected void removeFromOldFlashData(array $keys)

Remove the given keys from the old flash data.

Parameters

array $keys

Return Value

void

in Store at line 537
void flashInput(array $value)

Flash an input array to the session.

Parameters

array $value

Return Value

void

in Store at line 548
mixed remove(string $key)

Remove an item from the session, returning its value.

Parameters

string $key

Return Value

mixed

in Store at line 559
void forget(string|array $keys)

Remove one or many items from the session.

Parameters

string|array $keys

Return Value

void

in Store at line 569
void flush()

Remove all of the items from the session.

Return Value

void

in Store at line 579
bool invalidate()

Flush the session data and regenerate the ID.

Return Value

bool

in Store at line 592
bool regenerate(bool $destroy = false)

Generate a new session identifier.

Parameters

bool $destroy

Return Value

bool

in Store at line 605
bool migrate(bool $destroy = false)

Generate a new session ID for the session.

Parameters

bool $destroy

Return Value

bool

in Store at line 623
bool isStarted()

Determine if the session has been started.

Return Value

bool

in Store at line 633
string getName()

Get the name of the session.

Return Value

string

in Store at line 644
void setName(string $name)

Set the name of the session.

Parameters

string $name

Return Value

void

in Store at line 654
string id()

Get the current session ID.

Return Value

string

in Store at line 664
string getId()

Get the current session ID.

Return Value

string

in Store at line 675
void setId(string $id)

Set the session ID.

Parameters

string $id

Return Value

void

in Store at line 686
bool isValidId(string|null $id)

Determine if this is a valid session ID.

Parameters

string|null $id

Return Value

bool

in Store at line 696
protected string generateSessionId()

Get a new, random session ID.

Return Value

string

in Store at line 707
void setExists(bool $value)

Set the existence of the session on the handler if applicable.

Parameters

bool $value

Return Value

void

in Store at line 719
string token()

Get the CSRF token value.

Return Value

string

in Store at line 729
void regenerateToken()

Regenerate the CSRF token value.

Return Value

void

in Store at line 739
bool hasPreviousUri()

Determine if the previous URI is available.

Return Value

bool

in Store at line 751
Uri previousUri()

Get the previous URL from the session as a URI instance.

Return Value

Uri

Exceptions

RuntimeException

in Store at line 765
string|null previousUrl()

Get the previous URL from the session.

Return Value

string|null

in Store at line 776
void setPreviousUrl(string $url)

Set the "previous" URL in the session.

Parameters

string $url

Return Value

void

in Store at line 786
void passwordConfirmed()

Specify that the user has confirmed their password.

Return Value

void

in Store at line 796
SessionHandlerInterface getHandler()

Get the underlying session handler implementation.

Return Value

SessionHandlerInterface

in Store at line 807
SessionHandlerInterface setHandler(SessionHandlerInterface $handler)

Set the underlying session handler implementation.

Parameters

SessionHandlerInterface $handler

Return Value

SessionHandlerInterface

in Store at line 817
bool handlerNeedsRequest()

Determine if the session handler needs a request.

Return Value

bool

in Store at line 828
void setRequestOnHandler(Request $request)

Set the request on the handler instance.

Parameters

Request $request

Return Value

void

at line 65
Encrypter getEncrypter()

Get the encrypter instance.

Return Value

Encrypter