1. class
  2. Illuminate
  3. Session
  4. EncryptedStore

EncryptedStore

class EncryptedStore extends Store (View source)

Methods

void
__construct( string $name, SessionHandlerInterface $handler, Encrypter $encrypter, string|null $id = null)

Create a new session instance.

start()

{@inheritdoc}

from Store
getId()

{@inheritdoc}

from Store
setId($id)

{@inheritdoc}

from Store
bool
isValidId( string $id)

Determine if this is a valid session ID.

from Store
getName()

{@inheritdoc}

from Store
setName($name)

{@inheritdoc}

from Store
invalidate($lifetime = null)

{@inheritdoc}

from Store
migrate($destroy = false, $lifetime = null)

{@inheritdoc}

from Store
bool
regenerate( bool $destroy = false)

Generate a new session identifier.

from Store
save()

{@inheritdoc}

from Store
void
ageFlashData()

Age the flash data for the session.

from Store
has($name)

{@inheritdoc}

from Store
get($name, $default = null)

{@inheritdoc}

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

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

from Store
bool
hasOldInput( string $key = null)

Determine if the session contains old input.

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

Get the requested item from the flashed input array.

from Store
set($name, $value)

{@inheritdoc}

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
void
push( string $key, mixed $value)

Push a value onto a session array.

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

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
flashInput( array $value)

Flash an input array to the session.

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
all()

{@inheritdoc}

from Store
replace( array $attributes)

{@inheritdoc}

from Store
remove($name)

{@inheritdoc}

from Store
void
forget( string|array $keys)

Remove one or many items from the session.

from Store
clear()

{@inheritdoc}

from Store
void
flush()

Remove all of the items from the session.

from Store
isStarted()

{@inheritdoc}

from Store
registerBag( SessionBagInterface $bag)

{@inheritdoc}

from Store
getBag($name)

{@inheritdoc}

from Store
getMetadataBag()

{@inheritdoc}

from Store
array
getBagData( string $name)

Get the raw bag data array for a given bag.

from Store
string
token()

Get the CSRF token value.

from Store
string
getToken()

Get the CSRF token value.

from Store
void
regenerateToken()

Regenerate the CSRF token value.

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
setExists( bool $value)

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

from Store
SessionHandlerInterface
getHandler()

Get 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

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

Create a new session instance.

Parameters

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

Return Value

void

in Store at line line 90
start()

{@inheritdoc}

in Store at line line 162
getId()

{@inheritdoc}

in Store at line line 170
setId($id)

{@inheritdoc}

Parameters

$id

in Store at line line 185
bool isValidId( string $id)

Determine if this is a valid session ID.

Parameters

string $id

Return Value

bool

in Store at line line 203
getName()

{@inheritdoc}

in Store at line line 211
setName($name)

{@inheritdoc}

Parameters

$name

in Store at line line 219
invalidate($lifetime = null)

{@inheritdoc}

Parameters

$lifetime

in Store at line line 229
migrate($destroy = false, $lifetime = null)

{@inheritdoc}

Parameters

$destroy
$lifetime

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

Generate a new session identifier.

Parameters

bool $destroy

Return Value

bool

in Store at line line 256
save()

{@inheritdoc}

in Store at line line 299
void ageFlashData()

Age the flash data for the session.

Return Value

void

in Store at line line 311
has($name)

{@inheritdoc}

Parameters

$name

in Store at line line 319
get($name, $default = null)

{@inheritdoc}

Parameters

$name
$default

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

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

Parameters

string $key
string $default

Return Value

mixed

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

Determine if the session contains old input.

Parameters

string $key

Return Value

bool

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

Get the requested item from the flashed input array.

Parameters

string $key
mixed $default

Return Value

mixed

in Store at line line 369
set($name, $value)

{@inheritdoc}

Parameters

$name
$value

in Store at line 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 line 399
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 line 415
void flash( string $key, mixed $value)

Flash a key / value pair to the session.

Parameters

string $key
mixed $value

Return Value

void

in Store at line line 432
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 line 445
void flashInput( array $value)

Flash an input array to the session.

Parameters

array $value

Return Value

void

in Store at line line 455
void reflash()

Reflash all of the session flash data.

Return Value

void

in Store at line line 468
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 line 504
all()

{@inheritdoc}

in Store at line line 512
replace( array $attributes)

{@inheritdoc}

Parameters

array $attributes

in Store at line line 520
remove($name)

{@inheritdoc}

Parameters

$name

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

Remove one or many items from the session.

Parameters

string|array $keys

Return Value

void

in Store at line line 539
clear()

{@inheritdoc}

in Store at line line 553
void flush()

Remove all of the items from the session.

Return Value

void

in Store at line line 561
isStarted()

{@inheritdoc}

in Store at line line 569
registerBag( SessionBagInterface $bag)

{@inheritdoc}

Parameters

SessionBagInterface $bag

in Store at line line 577
getBag($name)

{@inheritdoc}

Parameters

$name

in Store at line line 587
getMetadataBag()

{@inheritdoc}

in Store at line line 598
array getBagData( string $name)

Get the raw bag data array for a given bag.

Parameters

string $name

Return Value

array

in Store at line line 608
string token()

Get the CSRF token value.

Return Value

string

in Store at line line 618
string getToken()

Get the CSRF token value.

Return Value

string

in Store at line line 628
void regenerateToken()

Regenerate the CSRF token value.

Return Value

void

in Store at line line 638
string|null previousUrl()

Get the previous URL from the session.

Return Value

string|null

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

Set the "previous" URL in the session.

Parameters

string $url

Return Value

void

in Store at line line 660
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 line 672
SessionHandlerInterface getHandler()

Get the underlying session handler implementation.

Return Value

SessionHandlerInterface

in Store at line line 682
bool handlerNeedsRequest()

Determine if the session handler needs a request.

Return Value

bool

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

Set the request on the handler instance.

Parameters

Request $request

Return Value

void

at line line 65
Encrypter getEncrypter()

Get the encrypter instance.

Return Value

Encrypter