Store
class Store implements SessionInterface (View source)
Properties
| protected string | $id | The session ID. |
|
| protected string | $name | The session name. |
|
| protected array | $attributes | The session attributes. |
|
| protected array | $bags | The session bags. |
|
| protected MetadataBag | $metaBag | The meta-data bag instance. |
|
| protected array | $bagData | Local copies of the session bag data. |
|
| protected SessionHandlerInterface | $handler | The session handler implementation. |
|
| protected bool | $started | Session store started status. |
Methods
Create a new session instance.
{@inheritdoc}
Load the session data from the handler.
Read the session data from the handler.
Initialize a bag in storage if it doesn't exist.
{@inheritdoc}
{@inheritdoc}
Determine if this is a valid session ID.
Get a new, random session ID.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Generate a new session identifier.
{@inheritdoc}
Merge all of the bag data into the session.
Age the flash data for the session.
{@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.
Push a value onto a session array.
Flash a key / value pair to the session.
Flash an input array to the session.
Reflash all of the session flash data.
Reflash a subset of the current flash data.
Merge new flash keys into the new flash array.
Remove the given keys from the old flash data.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Remove an item 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.
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.
Details
void
__construct(string $name, SessionHandlerInterface $handler, string|null $id = null)
Create a new session instance.
start()
{@inheritdoc}
protected void
loadSession()
Load the session data from the handler.
protected array
readFromHandler()
Read the session data from the handler.
protected void
initializeLocalBag(SessionBagInterface $bag)
Initialize a bag in storage if it doesn't exist.
getId()
{@inheritdoc}
setId($id)
{@inheritdoc}
bool
isValidId(string $id)
Determine if this is a valid session ID.
protected string
generateSessionId()
Get a new, random 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}
protected void
addBagDataToSession()
Merge all of the bag data into the session.
void
ageFlashData()
Age the flash data for the session.
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|null $value = null)
Put a key / value pair or array of key / value pairs in the session.
void
push(string $key, mixed $value)
Push a value onto a session array.
void
flash(string $key, mixed $value)
Flash a key / value pair to the session.
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.
protected void
mergeNewFlashes(array $keys)
Merge new flash keys into the new flash array.
protected void
removeFromOldFlashData(array $keys)
Remove the given keys from the old flash data.
all()
{@inheritdoc}
replace(array $attributes)
{@inheritdoc}
remove($name)
{@inheritdoc}
void
forget(string $key)
Remove an item 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.
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.