| Methods |
public
|
__construct(string $name, SessionHandlerInterface $handler, string|null $id = null, string $serialization = 'php'): void
Create a new session instance.
Create a new session instance.
|
#
|
public
|
start(): bool
Start the session, reading the data from a handler.
Start the session, reading the data from a handler.
Implements
|
#
|
protected
|
loadSession(): void
Load the session data from the handler.
Load the session data from the handler.
|
#
|
protected
|
readFromHandler(): array
Read the session data from the handler.
Read the session data from the handler.
|
#
|
protected
|
prepareForUnserialize(string $data): string
Prepare the raw string data from the session for unserialization.
Prepare the raw string data from the session for unserialization.
|
#
|
protected
|
marshalErrorBag(): void
Marshal the ViewErrorBag when using JSON serialization for sessions.
Marshal the ViewErrorBag when using JSON serialization for sessions.
|
#
|
public
|
save(): void
Save the session data to storage.
Save the session data to storage.
Implements
|
#
|
protected
|
prepareErrorBagForSerialization(): void
Prepare the ViewErrorBag instance for JSON serialization.
Prepare the ViewErrorBag instance for JSON serialization.
|
#
|
protected
|
prepareForStorage(string $data): string
Prepare the serialized session data for storage.
Prepare the serialized session data for storage.
|
#
|
public
|
ageFlashData(): void
Age the flash data for the session.
Age the flash data for the session.
|
#
|
public
|
all(): array
Get all of the session data.
Get all of the session data.
Implements
|
#
|
public
|
only(array $keys): array
Get a subset of the session data.
Get a subset of the session data.
|
#
|
public
|
except(array $keys): array
Get all the session data except for a specified array of items.
Get all the session data except for a specified array of items.
|
#
|
public
|
exists(string|array $key): bool
Checks if a key exists.
|
#
|
public
|
missing(string|array $key): bool
Determine if the given key is missing from the session data.
Determine if the given key is missing from the session data.
|
#
|
public
|
has(string|array $key): bool
Determine if a key is present and not null.
Determine if a key is present and not null.
Implements
|
#
|
public
|
hasAny(string|array $key): bool
Determine if any of the given keys are present and not null.
Determine if any of the given keys are present and not null.
|
#
|
public
|
get(string $key, mixed $default = null): mixed
Get an item from the session.
Get an item from the session.
Implements
|
#
|
public
|
pull(string $key, mixed $default = null): mixed
Get the value of a given key and then forget it.
Get the value of a given key and then forget it.
Implements
|
#
|
public
|
hasOldInput(string|null $key = null): bool
Determine if the session contains old input.
Determine if the session contains old input.
|
#
|
public
|
getOldInput(string|null $key = null, mixed $default = null): mixed
Get the requested item from the flashed input array.
Get the requested item from the flashed input array.
|
#
|
public
|
replace(array $attributes): void
Replace the given session attributes entirely.
Replace the given session attributes entirely.
|
#
|
public
|
put(string|array $key, mixed $value = null): void
Put a key / value pair or array of key / value pairs in the session.
Put a key / value pair or array of key / value pairs in the session.
Implements
|
#
|
public
|
remember(string $key, Closure $callback): mixed
Get an item from the session, or store the default value.
Get an item from the session, or store the default value.
|
#
|
public
|
push(string $key, mixed $value): void
Push a value onto a session array.
Push a value onto a session array.
|
#
|
public
|
increment(string $key, int $amount = 1): mixed
Increment the value of an item in the session.
Increment the value of an item in the session.
|
#
|
public
|
decrement(string $key, int $amount = 1): int
Decrement the value of an item in the session.
Decrement the value of an item in the session.
|
#
|
public
|
flash(string $key, mixed $value = true): void
Flash a key / value pair to the session.
Flash a key / value pair to the session.
Implements
|
#
|
public
|
now(string $key, mixed $value): void
Flash a key / value pair to the session for immediate use.
Flash a key / value pair to the session for immediate use.
|
#
|
public
|
reflash(): void
Reflash all of the session flash data.
Reflash all of the session flash data.
|
#
|
public
|
keep(array|mixed $keys = null): void
Reflash a subset of the current flash data.
Reflash a subset of the current flash data.
|
#
|
protected
|
mergeNewFlashes(array $keys): void
Merge new flash keys into the new flash array.
Merge new flash keys into the new flash array.
|
#
|
protected
|
removeFromOldFlashData(array $keys): void
Remove the given keys from the old flash data.
Remove the given keys from the old flash data.
|
#
|
public
|
flashInput(array $value): void
Flash an input array to the session.
Flash an input array to the session.
|
#
|
public
|
remove(string $key): mixed
Remove an item from the session, returning its value.
Remove an item from the session, returning its value.
Implements
|
#
|
public
|
forget(string|array $keys): void
Remove one or many items from the session.
Remove one or many items from the session.
Implements
|
#
|
public
|
flush(): void
Remove all of the items from the session.
Remove all of the items from the session.
Implements
|
#
|
public
|
invalidate(): bool
Flush the session data and regenerate the ID.
Flush the session data and regenerate the ID.
Implements
|
#
|
public
|
regenerate(bool $destroy = false): bool
Generate a new session identifier.
Generate a new session identifier.
Implements
|
#
|
public
|
migrate(bool $destroy = false): bool
Generate a new session ID for the session.
Generate a new session ID for the session.
Implements
|
#
|
public
|
isStarted(): bool
Determine if the session has been started.
Determine if the session has been started.
Implements
|
#
|
public
|
getName(): string
Get the name of the session.
Get the name of the session.
Implements
|
#
|
public
|
setName(string $name): void
Set the name of the session.
Set the name of the session.
Implements
|
#
|
public
|
id(): string
Get the current session ID.
Get the current session ID.
|
#
|
public
|
getId(): string
Get the current session ID.
Get the current session ID.
Implements
|
#
|
public
|
setId(string|null $id): void
Set the session ID.
|
#
|
public
|
isValidId(string|null $id): bool
Determine if this is a valid session ID.
Determine if this is a valid session ID.
|
#
|
protected
|
generateSessionId(): string
Get a new, random session ID.
Get a new, random session ID.
|
#
|
public
|
setExists(bool $value): void
Set the existence of the session on the handler if applicable.
Set the existence of the session on the handler if applicable.
|
#
|
public
|
token(): string
Get the CSRF token value.
Get the CSRF token value.
Implements
|
#
|
public
|
regenerateToken(): void
Regenerate the CSRF token value.
Regenerate the CSRF token value.
Implements
|
#
|
public
|
hasPreviousUri(): bool
Determine if the previous URI is available.
Determine if the previous URI is available.
|
#
|
public
|
previousUri(): Uri
Get the previous URL from the session as a URI instance.
Get the previous URL from the session as a URI instance.
Throws
|
#
|
public
|
previousUrl(): string|null
Get the previous URL from the session.
Get the previous URL from the session.
Implements
|
#
|
public
|
setPreviousUrl(string $url): void
Set the "previous" URL in the session.
Set the "previous" URL in the session.
Implements
|
#
|
public
|
passwordConfirmed(): void
Specify that the user has confirmed their password.
Specify that the user has confirmed their password.
|
#
|
public
|
getHandler(): SessionHandlerInterface
Get the underlying session handler implementation.
Get the underlying session handler implementation.
Implements
|
#
|
public
|
setHandler(SessionHandlerInterface $handler): SessionHandlerInterface
Set the underlying session handler implementation.
Set the underlying session handler implementation.
|
#
|
public
|
handlerNeedsRequest(): bool
Determine if the session handler needs a request.
Determine if the session handler needs a request.
Implements
|
#
|
public
|
setRequestOnHandler(Request $request): void
Set the request on the handler instance.
Set the request on the handler instance.
Implements
|
#
|