class Store implements SessionInterface (View source)
void | __construct(string $name, SessionHandlerInterface $handler, string|null $id = null) Create a new session instance. | |
start() {@inheritdoc} | ||
getId() {@inheritdoc} | ||
setId($id) {@inheritdoc} | ||
bool | isValidId(string $id) Determine if this is a valid session ID. | |
getName() {@inheritdoc} | ||
setName($name) {@inheritdoc} | ||
invalidate($lifetime = null) {@inheritdoc} | ||
migrate($destroy = false, $lifetime = null) {@inheritdoc} | ||
bool | regenerate(bool $destroy = false) Generate a new session identifier. | |
save() {@inheritdoc} | ||
void | ageFlashData() Age the flash data for the session. | |
bool | exists(string|array $key) Checks if an attribute exists. | |
has($name) {@inheritdoc} | ||
get($name, $default = null) {@inheritdoc} | ||
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) {@inheritdoc} | ||
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() {@inheritdoc} | ||
replace(array $attributes) {@inheritdoc} | ||
remove($name) {@inheritdoc} | ||
void | forget(string|array $keys) Remove one or many items from the session. | |
clear() {@inheritdoc} | ||
void | flush() Remove all of the items from the session. | |
isStarted() {@inheritdoc} | ||
registerBag(SessionBagInterface $bag) {@inheritdoc} | ||
getBag($name) {@inheritdoc} | ||
getMetadataBag() {@inheritdoc} | ||
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. | |
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. |
Create a new session instance.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Determine if this is a valid session ID.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Generate a new session identifier.
{@inheritdoc}
Age the flash data for the session.
Checks if an attribute exists.
{@inheritdoc}
{@inheritdoc}
Get the value of a given key and then forget it.
Determine if the session contains old input.
Get the requested item from the flashed input array.
{@inheritdoc}
Put a key / value pair or array of key / value pairs in the session.
Get an item from the session, or store the default value.
Push a value onto a session array.
Increment the value of an item in the session.
Decrement the value of an item in the session.
Flash a key / value pair to the session.
Flash a key / value pair to the session for immediate use.
Flash an input array to the session.
Reflash all of the session flash data.
Reflash a subset of the current flash data.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Remove one or many items from the session.
{@inheritdoc}
Remove all of the items from the session.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Get the raw bag data array for a given bag.
Get the CSRF token value.
Get the CSRF token value.
Regenerate the CSRF token value.
Get the previous URL from the session.
Set the "previous" URL in the session.
Set the existence of the session on the handler if applicable.
Get the underlying session handler implementation.
Determine if the session handler needs a request.
Set the request on the handler instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Session/Store.html