Store

class Store implements Session (View source)

Properties

protected string $id The session ID.
protected string $name The session name.
protected array $attributes The session attributes.
protected SessionHandlerInterface $handler The session handler implementation.
protected bool $started Session store started status.

Methods

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

Create a new session instance.
bool start()

Start the session, reading the data from a handler.
void loadSession()

Load the session data from the handler.
array readFromHandler()

Read the session data from the handler.
string prepareForUnserialize(string $data)

Prepare the raw string data from the session for unserialization.
void save()

Save the session data to storage.
string prepareForStorage(string $data)

Prepare the serialized session data for storage.
void ageFlashData()

Age the flash data for the session.
array all()

Get all of the session data.
array only(array $keys)

Get a subset of the session data.
bool exists(string|array $key)

Checks if a key exists.
bool has(string|array $key)

Checks if a key is present and not null.
mixed get(string $key, mixed $default = null)

Get an item from the session.
mixed pull(string $key, mixed $default = null)

Get the value of a given key and then forget it.
bool hasOldInput(string|null $key = null)

Determine if the session contains old input.
mixed getOldInput(string|null $key = null, mixed $default = null)

Get the requested item from the flashed input array.
void replace(array $attributes)

Replace the given session attributes entirely.
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 = true)

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

Reflash all of the session flash data.
void keep(array|mixed $keys = null)

Reflash a subset of the current flash data.
void mergeNewFlashes(array $keys)

Merge new flash keys into the new flash array.
void removeFromOldFlashData(array $keys)

Remove the given keys from the old flash data.
void flashInput(array $value)

Flash an input array to the session.
mixed remove(string $key)

Remove an item from the session, returning its value.
void forget(string|array $keys)

Remove one or many items from the session.
void flush()

Remove all of the items from the session.
bool invalidate()

Flush the session data and regenerate the ID.
bool regenerate(bool $destroy = false)

Generate a new session identifier.
bool migrate(bool $destroy = false)

Generate a new session ID for the session.
bool isStarted()

Determine if the session has been started.
string getName()

Get the name of the session.
void setName(string $name)

Set the name of the session.
string getId()

Get the current session ID.
void setId(string $id)

Set the session ID.
bool isValidId(string $id)

Determine if this is a valid session ID.
string generateSessionId()

Get a new, random session ID.
void setExists(bool $value)

Set the existence of the session on the handler if applicable.
string token()

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

Specify that the user has confirmed their password.
SessionHandlerInterface 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

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

bool start()

Start the session, reading the data from a handler.

Return Value

bool

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

void save()

Save the session data to storage.

Return Value

void

protected string prepareForStorage(string $data)

Prepare the serialized session data for storage.

Parameters

string $data

Return Value

string

void ageFlashData()

Age the flash data for the session.

Return Value

void

array all()

Get all of the session data.

Return Value

array

array only(array $keys)

Get a subset of the session data.

Parameters

array $keys

Return Value

array

bool exists(string|array $key)

Checks if a key exists.

Parameters

string|array $key

Return Value

bool

bool has(string|array $key)

Checks if a key is present and not null.

Parameters

string|array $key

Return Value

bool

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

Get an item from the session.

Parameters

string $key
mixed $default

Return Value

mixed

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

bool hasOldInput(string|null $key = null)

Determine if the session contains old input.

Parameters

string|null $key

Return Value

bool

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

void replace(array $attributes)

Replace the given session attributes entirely.

Parameters

array $attributes

Return Value

void

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

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

void push(string $key, mixed $value)

Push a value onto a session array.

Parameters

string $key
mixed $value

Return Value

void

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

Increment the value of an item in the session.

Parameters

string $key
int $amount

Return Value

mixed

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

Decrement the value of an item in the session.

Parameters

string $key
int $amount

Return Value

int

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

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

void flashInput(array $value)

Flash an input array to the session.

Parameters

array $value

Return Value

void

mixed remove(string $key)

Remove an item from the session, returning its value.

Parameters

string $key

Return Value

mixed

void forget(string|array $keys)

Remove one or many items from the session.

Parameters

string|array $keys

Return Value

void

void flush()

Remove all of the items from the session.

Return Value

void

bool invalidate()

Flush the session data and regenerate the ID.

Return Value

bool

bool regenerate(bool $destroy = false)

Generate a new session identifier.

Parameters

bool $destroy

Return Value

bool

bool migrate(bool $destroy = false)

Generate a new session ID for the session.

Parameters

bool $destroy

Return Value

bool

bool isStarted()

Determine if the session has been started.

Return Value

bool

string getName()

Get the name of the session.

Return Value

string

void setName(string $name)

Set the name of the session.

Parameters

string $name

Return Value

void

string getId()

Get the current session ID.

Return Value

string

void setId(string $id)

Set the session ID.

Parameters

string $id

Return Value

void

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

void setExists(bool $value)

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

Parameters

bool $value

Return Value

void

string token()

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

Specify that the user has confirmed their password.

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

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