W3cubDocs

/Laravel 5.1

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

[email protected]}

 from Store
getId()

[email protected]}

 from Store
setId($id)

[email protected]}

 from Store
bool isValidId( string $id)

Determine if this is a valid session ID.

 from Store
getName()

[email protected]}

 from Store
setName($name)

[email protected]}

 from Store
invalidate($lifetime = null)

[email protected]}

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

[email protected]}

 from Store
bool regenerate( bool $destroy = false)

Generate a new session identifier.

 from Store
save()

[email protected]}

 from Store
void ageFlashData()

Age the flash data for the session.

 from Store
has($name)

[email protected]}

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

[email protected]}

 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)

[email protected]}

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

[email protected]}

 from Store
replace( array $attributes)

[email protected]}

 from Store
remove($name)

[email protected]}

 from Store
void forget( string|array $keys)

Remove one or many items from the session.

 from Store
clear()

[email protected]}

 from Store
void flush()

Remove all of the items from the session.

 from Store
isStarted()

[email protected]}

 from Store
registerBag( SessionBagInterface $bag)

[email protected]}

 from Store
getBag($name)

[email protected]}

 from Store
getMetadataBag()

[email protected]}

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

[email protected]}

getId()

[email protected]}

setId($id)

[email protected]}

Parameters

$id

bool isValidId( string $id)

Determine if this is a valid session ID.

Parameters

string $id

Return Value

bool

getName()

[email protected]}

setName($name)

[email protected]}

Parameters

$name

invalidate($lifetime = null)

[email protected]}

Parameters

$lifetime

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

[email protected]}

Parameters

$destroy
$lifetime

bool regenerate( bool $destroy = false)

Generate a new session identifier.

Parameters

bool $destroy

Return Value

bool

save()

[email protected]}

void ageFlashData()

Age the flash data for the session.

Return Value

void

has($name)

[email protected]}

Parameters

$name

get($name, $default = null)

[email protected]}

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)

[email protected]}

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

all()

[email protected]}

replace( array $attributes)

[email protected]}

Parameters

array $attributes

remove($name)

[email protected]}

Parameters

$name

void forget( string|array $keys)

Remove one or many items from the session.

Parameters

string|array $keys

Return Value

void

clear()

[email protected]}

void flush()

Remove all of the items from the session.

Return Value

void

isStarted()

[email protected]}

registerBag( SessionBagInterface $bag)

[email protected]}

Parameters

SessionBagInterface $bag

getBag($name)

[email protected]}

Parameters

$name

getMetadataBag()

[email protected]}

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.1/Illuminate/Session/EncryptedStore.html