class Store implements SessionInterface (View source)

Methods

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

Create a new session instance.

start()

[email protected]}

getId()

[email protected]}

setId($id)

[email protected]}

bool
isValidId(string $id)

Determine if this is a valid session ID.

getName()

[email protected]}

setName($name)

[email protected]}

invalidate($lifetime = null)

[email protected]}

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

[email protected]}

bool
regenerate(bool $destroy = false)

Generate a new session identifier.

save()

[email protected]}

void
ageFlashData()

Age the flash data for the session.

bool
exists(string|array $key)

Checks if an attribute exists.

has($name)

[email protected]}

get($name, $default = null)

[email protected]}

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

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

bool
hasOldInput(string $key = null)

Determine if the session contains old input.

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

Get the requested item from the flashed input array.

set($name, $value)

[email protected]}

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

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

mixed
remember(string $key, Closure $callback)

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

void
push(string $key, mixed $value)

Push a value onto a session array.

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

Increment the value of an item in the session.

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

Decrement the value of an item in the session.

void
flash(string $key, mixed $value)

Flash a key / value pair to the session.

void
now(string $key, mixed $value)

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

void
flashInput(array $value)

Flash an input array to the session.

void
reflash()

Reflash all of the session flash data.

void
keep(array|mixed $keys = null)

Reflash a subset of the current flash data.

all()

[email protected]}

replace(array $attributes)

[email protected]}

remove($name)

[email protected]}

void
forget(string|array $keys)

Remove one or many items from the session.

clear()

[email protected]}

void
flush()

Remove all of the items from the session.

isStarted()

[email protected]}

registerBag(SessionBagInterface $bag)

[email protected]}

getBag($name)

[email protected]}

getMetadataBag()

[email protected]}

array
getBagData(string $name)

Get the raw bag data array for a given bag.

string
token()

Get the CSRF token value.

string
getToken()

Get the CSRF token value.

void
regenerateToken()

Regenerate the CSRF token value.

string|null
previousUrl()

Get the previous URL from the session.

void
setPreviousUrl(string $url)

Set the "previous" URL in the session.

void
setExists(bool $value)

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

getHandler()

Get the underlying session handler implementation.

bool
handlerNeedsRequest()

Determine if the session handler needs a request.

void
setRequestOnHandler(Request $request)

Set the request on the handler instance.

Details

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

Create a new session instance.

Parameters

string $name
SessionHandlerInterface $handler
string|null $id

Return Value

void

at line line 91
start()

[email protected]}

at line line 163
getId()

[email protected]}

at line line 171
setId($id)

[email protected]}

Parameters

$id

at line line 186
bool isValidId(string $id)

Determine if this is a valid session ID.

Parameters

string $id

Return Value

bool

at line line 204
getName()

[email protected]}

at line line 212
setName($name)

[email protected]}

Parameters

$name

at line line 220
invalidate($lifetime = null)

[email protected]}

Parameters

$lifetime

at line line 230
migrate($destroy = false, $lifetime = null)

[email protected]}

Parameters

$destroy
$lifetime

at line line 249
bool regenerate(bool $destroy = false)

Generate a new session identifier.

Parameters

bool $destroy

Return Value

bool

at line line 257
save()

[email protected]}

at line line 300
void ageFlashData()

Age the flash data for the session.

Return Value

void

at line line 312
bool exists(string|array $key)

Checks if an attribute exists.

Parameters

string|array $key

Return Value

bool

at line line 328
has($name)

[email protected]}

Parameters

$name

at line line 344
get($name, $default = null)

[email protected]}

Parameters

$name
$default

at line line 356
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

at line line 367
bool hasOldInput(string $key = null)

Determine if the session contains old input.

Parameters

string $key

Return Value

bool

at line line 381
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

at line line 394
set($name, $value)

[email protected]}

Parameters

$name
$value

at line line 406
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

at line line 424
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

at line line 442
void push(string $key, mixed $value)

Push a value onto a session array.

Parameters

string $key
mixed $value

Return Value

void

at line line 458
mixed increment(string $key, int $amount = 1)

Increment the value of an item in the session.

Parameters

string $key
int $amount

Return Value

mixed

at line line 474
int decrement(string $key, int $amount = 1)

Decrement the value of an item in the session.

Parameters

string $key
int $amount

Return Value

int

at line line 486
void flash(string $key, mixed $value)

Flash a key / value pair to the session.

Parameters

string $key
mixed $value

Return Value

void

at line line 502
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

at line line 515
void flashInput(array $value)

Flash an input array to the session.

Parameters

array $value

Return Value

void

at line line 525
void reflash()

Reflash all of the session flash data.

Return Value

void

at line line 538
void keep(array|mixed $keys = null)

Reflash a subset of the current flash data.

Parameters

array|mixed $keys

Return Value

void

at line line 574
all()

[email protected]}

at line line 582
replace(array $attributes)

[email protected]}

Parameters

array $attributes

at line line 590
remove($name)

[email protected]}

Parameters

$name

at line line 601
void forget(string|array $keys)

Remove one or many items from the session.

Parameters

string|array $keys

Return Value

void

at line line 609
clear()

[email protected]}

at line line 623
void flush()

Remove all of the items from the session.

Return Value

void

at line line 631
isStarted()

[email protected]}

at line line 639
registerBag(SessionBagInterface $bag)

[email protected]}

Parameters

SessionBagInterface $bag

at line line 647
getBag($name)

[email protected]}

Parameters

$name

at line line 657
getMetadataBag()

[email protected]}

at line line 668
array getBagData(string $name)

Get the raw bag data array for a given bag.

Parameters

string $name

Return Value

array

at line line 678
string token()

Get the CSRF token value.

Return Value

string

at line line 688
string getToken()

Get the CSRF token value.

Return Value

string

at line line 698
void regenerateToken()

Regenerate the CSRF token value.

Return Value

void

at line line 708
string|null previousUrl()

Get the previous URL from the session.

Return Value

string|null

at line line 719
void setPreviousUrl(string $url)

Set the "previous" URL in the session.

Parameters

string $url

Return Value

void

at line line 730
void setExists(bool $value)

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

Parameters

bool $value

Return Value

void

at line line 742
SessionHandlerInterface getHandler()

Get the underlying session handler implementation.

at line line 752
bool handlerNeedsRequest()

Determine if the session handler needs a request.

Return Value

bool

at line line 763
void setRequestOnHandler(Request $request)

Set the request on the handler instance.

Parameters

Request $request

Return Value

void