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 array	$bags	The session bags.	from Store
protected MetadataBag	$metaBag	The meta-data bag instance.	from Store
protected array	$bagData	Local copies of the session bag data.	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

void

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

Create a new session instance.

start()

{@inheritdoc}

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

initializeLocalBag(SessionBagInterface $bag)

Initialize a bag in storage if it doesn't exist.

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

string

generateSessionId()

Get a new, random 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

string

prepareForStorage(string $data)

Prepare the serialized session data for storage.

void

addBagDataToSession()

Merge all of the bag data into the session.

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

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

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

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

start()

{@inheritdoc}

protected void loadSession()

Load the session data from the handler.

Return Value

void

protected array readFromHandler()

Read the session data from the handler.

Return Value

array

protected string prepareForUnserialize(string $data)

Prepare the raw string data from the session for unserialization.

Parameters

string

$data

Return Value

string

protected void initializeLocalBag(SessionBagInterface $bag)

Initialize a bag in storage if it doesn't exist.

Parameters

SessionBagInterface

$bag

Return Value

void

getId()

{@inheritdoc}

setId($id)

{@inheritdoc}

Parameters

$id

bool isValidId(string $id)

Determine if this is a valid session ID.

Parameters

string

$id

Return Value

bool

protected string generateSessionId()

Get a new, random session ID.

Return Value

string

getName()

{@inheritdoc}

setName($name)

{@inheritdoc}

Parameters

$name

invalidate($lifetime = null)

{@inheritdoc}

Parameters

$lifetime

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

{@inheritdoc}

Parameters

	$destroy
	$lifetime

bool regenerate(bool $destroy = false)

Generate a new session identifier.

Parameters

bool

$destroy

Return Value

bool

save()

{@inheritdoc}

protected string prepareForStorage(string $data)

Prepare the serialized session data for storage.

Parameters

string

$data

Return Value

string

protected void addBagDataToSession()

Merge all of the bag data into the session.

Return Value

void

void ageFlashData()

Age the flash data for the session.

Return Value

void

has($name)

{@inheritdoc}

Parameters

$name

get($name, $default = null)

{@inheritdoc}

Parameters

	$name
	$default

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

bool hasOldInput(string $key = null)

Determine if the session contains old input.

Parameters

string

$key

Return Value

bool

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

set($name, $value)

{@inheritdoc}

Parameters

	$name
	$value

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

void push(string $key, mixed $value)

Push a value onto a session array.

Parameters

string	$key
mixed	$value

Return Value

void

void flash(string $key, mixed $value)

Flash a key / value pair to the session.

Parameters

string	$key
mixed	$value

Return Value

void

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

void flashInput(array $value)

Flash an input array to the session.

Parameters

array

$value

Return Value

void

void reflash()

Reflash all of the session flash data.

Return Value

void

void keep(array|mixed $keys = null)

Reflash a subset of the current flash data.

Parameters

array|mixed

$keys

Return Value

void

protected void mergeNewFlashes(array $keys)

Merge new flash keys into the new flash array.

Parameters

array

$keys

Return Value

void

protected void removeFromOldFlashData(array $keys)

Remove the given keys from the old flash data.

Parameters

array

$keys

Return Value

void

all()

{@inheritdoc}

replace(array $attributes)

{@inheritdoc}

Parameters

array

$attributes

remove($name)

{@inheritdoc}

Parameters

$name

void forget(string|array $keys)

Remove one or many items from the session.

Parameters

string|array

$keys

Return Value

void

clear()

{@inheritdoc}

void flush()

Remove all of the items from the session.

Return Value

void

isStarted()

{@inheritdoc}

registerBag(SessionBagInterface $bag)

{@inheritdoc}

Parameters

SessionBagInterface

$bag

getBag($name)

{@inheritdoc}

Parameters

$name

getMetadataBag()

{@inheritdoc}

array getBagData(string $name)

Get the raw bag data array for a given bag.

Parameters

string

$name

Return Value

array

string token()

Get the CSRF token value.

Return Value

string

string getToken()

Get the CSRF token value.

Return Value

string

void regenerateToken()

Regenerate the CSRF token value.

Return Value

void

string|null previousUrl()

Get the previous URL from the session.

Return Value

string|null

void setPreviousUrl(string $url)

Set the "previous" URL in the session.

Parameters

string

$url

Return Value

void

void setExists(bool $value)

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

Parameters

bool

$value

Return Value

void

SessionHandlerInterface getHandler()

Get the underlying session handler implementation.

Return Value

SessionHandlerInterface

bool handlerNeedsRequest()

Determine if the session handler needs a request.

Return Value

bool

void setRequestOnHandler(Request $request)

Set the request on the handler instance.

Parameters

Request

$request

Return Value

void

Encrypter getEncrypter()

Get the encrypter instance.

Return Value

Encrypter

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Session/EncryptedStore.html