1. interface
  2. Hypervel
  3. \
  4. Contracts
  5. \
  6. Session
  7. \
  8. Session

Session

interface Session

Methods

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|null $id)

Set the session ID.

bool
start()

Start the session, reading the data from a handler.

void
save()

Save the session data to storage.

array
all()

Get all of the session data.

bool
exists(array|UnitEnum|string $key)

Checks if a key exists.

bool
has(array|UnitEnum|string $key)

Checks if a key is present and not null.

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

Get an item from the session.

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

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

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

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

void
replace(array $attributes)

Replace the given session attributes entirely.

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

Flash a key / value pair to the session.

void
flashInput(array $value)

Flash an array of input to the session.

void
reflash()

Reflash all of the session flash data.

array
only(array $keys)

Get a subset of the session data.

bool
hasOldInput(UnitEnum|string|null $key = null)

Determine if the flashed input contains an item.

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

Get the requested item from the flashed input array.

string|null
token()

Get the CSRF token value.

void
regenerateToken()

Regenerate the CSRF token value.

mixed
remove(UnitEnum|string $key)

Remove an item from the session, returning its value.

void
forget(array|UnitEnum|string $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.

void
markAsReadOnly()

Mark the session as read-only for the current request.

bool
isReadOnly()

Determine if the session is read-only for the current request.

string|null
previousUrl()

Get the previous URL from the session.

void
setPreviousUrl(string $url)

Set the "previous" URL in the session.

void
passwordConfirmed(string|null $guard = null)

Specify that the user has confirmed their password.

SessionHandlerInterface
getHandler()

Get the session handler instance.

bool
handlerNeedsRequest()

Determine if the session handler needs a request.

void
setRequestOnHandler(Request $request)

Set the request on the handler instance.

Details

at line 17
string getName()

Get the name of the session.

Return Value

string

at line 22
void setName(string $name)

Set the name of the session.

Parameters

string $name

Return Value

void

at line 28
string getId()

Get the current session ID.

Return Value

string

at line 33
void setId(string|null $id)

Set the session ID.

Parameters

string|null $id

Return Value

void

at line 38
bool start()

Start the session, reading the data from a handler.

Return Value

bool

at line 43
void save()

Save the session data to storage.

Return Value

void

at line 48
array all()

Get all of the session data.

Return Value

array

at line 53
bool exists(array|UnitEnum|string $key)

Checks if a key exists.

Parameters

array|UnitEnum|string $key

Return Value

bool

at line 58
bool has(array|UnitEnum|string $key)

Checks if a key is present and not null.

Parameters

array|UnitEnum|string $key

Return Value

bool

at line 63
mixed get(UnitEnum|string $key, mixed $default = null)

Get an item from the session.

Parameters

UnitEnum|string $key
mixed $default

Return Value

mixed

at line 68
mixed pull(UnitEnum|string $key, mixed $default = null)

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

Parameters

UnitEnum|string $key
mixed $default

Return Value

mixed

at line 73
void put(array|UnitEnum|string $key, mixed $value = null)

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

Parameters

array|UnitEnum|string $key
mixed $value

Return Value

void

at line 78
void replace(array $attributes)

Replace the given session attributes entirely.

Parameters

array $attributes

Return Value

void

at line 83
void flash(UnitEnum|string $key, mixed $value = true)

Flash a key / value pair to the session.

Parameters

UnitEnum|string $key
mixed $value

Return Value

void

at line 88
void flashInput(array $value)

Flash an array of input to the session.

Parameters

array $value

Return Value

void

at line 93
void reflash()

Reflash all of the session flash data.

Return Value

void

at line 98
array only(array $keys)

Get a subset of the session data.

Parameters

array $keys

Return Value

array

at line 103
bool hasOldInput(UnitEnum|string|null $key = null)

Determine if the flashed input contains an item.

Parameters

UnitEnum|string|null $key

Return Value

bool

at line 108
mixed getOldInput(UnitEnum|string|null $key = null, mixed $default = null)

Get the requested item from the flashed input array.

Parameters

UnitEnum|string|null $key
mixed $default

Return Value

mixed

at line 113
string|null token()

Get the CSRF token value.

Return Value

string|null

at line 118
void regenerateToken()

Regenerate the CSRF token value.

Return Value

void

at line 123
mixed remove(UnitEnum|string $key)

Remove an item from the session, returning its value.

Parameters

UnitEnum|string $key

Return Value

mixed

at line 128
void forget(array|UnitEnum|string $keys)

Remove one or many items from the session.

Parameters

array|UnitEnum|string $keys

Return Value

void

at line 133
void flush()

Remove all of the items from the session.

Return Value

void

at line 138
bool invalidate()

Flush the session data and regenerate the ID.

Return Value

bool

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

Generate a new session identifier.

Parameters

bool $destroy

Return Value

bool

at line 148
bool migrate(bool $destroy = false)

Generate a new session ID for the session.

Parameters

bool $destroy

Return Value

bool

at line 153
bool isStarted()

Determine if the session has been started.

Return Value

bool

at line 158
void markAsReadOnly()

Mark the session as read-only for the current request.

Return Value

void

at line 163
bool isReadOnly()

Determine if the session is read-only for the current request.

Return Value

bool

at line 168
string|null previousUrl()

Get the previous URL from the session.

Return Value

string|null

at line 173
void setPreviousUrl(string $url)

Set the "previous" URL in the session.

Parameters

string $url

Return Value

void

at line 178
void passwordConfirmed(string|null $guard = null)

Specify that the user has confirmed their password.

Parameters

string|null $guard

Return Value

void

at line 183
SessionHandlerInterface getHandler()

Get the session handler instance.

Return Value

SessionHandlerInterface

at line 188
bool handlerNeedsRequest()

Determine if the session handler needs a request.

Return Value

bool

at line 193
void setRequestOnHandler(Request $request)

Set the request on the handler instance.

Parameters

Request $request

Return Value

void