interface Session (View source)

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 $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(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.

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

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

string
token()

Get the CSRF token value.

void
regenerateToken()

Regenerate the CSRF token value.

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|null
previousUrl()

Get the previous URL from the session.

void
setPreviousUrl(string $url)

Set the "previous" URL in the session.

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

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

Start the session, reading the data from a handler.

Return Value

bool

void save()

Save the session data to storage.

Return Value

void

array all()

Get all of the session data.

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

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

string token()

Get the CSRF token value.

Return Value

string

void regenerateToken()

Regenerate the CSRF token 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|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

SessionHandlerInterface getHandler()

Get the session handler instance.

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