class SessionStore implements Store (View source)

Traits

Properties

string $key

The key for cache items.

Session $session

The session instance.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

int
currentTime()

Get the current system time as a UNIX timestamp.

string
runTimeForHumans(float $startTime, float|null $endTime = null)

Given a start time, format the total run time for human readability.

array
many(array $keys)

Retrieve multiple items from the cache by key.

bool
putMany(array $values, int $seconds)

Store multiple items in the cache for a given number of seconds.

__construct(Session $session, string $key = '_cache')

Create a new session cache store.

array<string, array{value: mixed, expiresAt: float}>
all()

Get all of the cached values and their expiration times.

mixed
get(string $key)

Retrieve an item from the cache by key.

bool
isExpired(int|float $expiresAt)

Determine if the given expiration time is expired.

bool
put(string $key, mixed $value, int $seconds)

Store an item in the cache for a given number of seconds.

float
toTimestamp(int $seconds)

Get the UNIX timestamp, with milliseconds, for the given number of seconds in the future.

int|bool
increment(string $key, mixed $value = 1)

Increment the value of an item in the cache.

int|bool
decrement(string $key, mixed $value = 1)

Decrement the value of an item in the cache.

bool
forever(string $key, mixed $value)

Store an item in the cache indefinitely.

bool
touch(string $key, int $seconds)

Adjust the expiration time of a cached item.

bool
forget(string $key)

Remove an item from the cache.

bool
flush()

Remove all items from the cache.

string
itemKey($key)

Get the cache key prefix.

string
getPrefix()

Get the cache key prefix.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

protected string runTimeForHumans(float $startTime, float|null $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float|null $endTime

Return Value

string

array many(array $keys)

Retrieve multiple items from the cache by key.

Items not found in the cache will have a null value.

Parameters

array $keys

Return Value

array

bool putMany(array $values, int $seconds)

Store multiple items in the cache for a given number of seconds.

Parameters

array $values
int $seconds

Return Value

bool

__construct(Session $session, string $key = '_cache')

Create a new session cache store.

Parameters

Session $session
string $key

array<string, array{value: mixed, expiresAt: float}> all()

Get all of the cached values and their expiration times.

Return Value

array<string, array{value: mixed, expiresAt: float}>

mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

protected bool isExpired(int|float $expiresAt)

Determine if the given expiration time is expired.

Parameters

int|float $expiresAt

Return Value

bool

bool put(string $key, mixed $value, int $seconds)

Store an item in the cache for a given number of seconds.

Parameters

string $key
mixed $value
int $seconds

Return Value

bool

protected float toTimestamp(int $seconds)

Get the UNIX timestamp, with milliseconds, for the given number of seconds in the future.

Parameters

int $seconds

Return Value

float

int|bool increment(string $key, mixed $value = 1)

Increment the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

int|bool decrement(string $key, mixed $value = 1)

Decrement the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

bool touch(string $key, int $seconds)

Adjust the expiration time of a cached item.

Parameters

string $key
int $seconds

Return Value

bool

bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

bool flush()

Remove all items from the cache.

Return Value

bool

string itemKey($key)

Get the cache key prefix.

Parameters

$key

Return Value

string

string getPrefix()

Get the cache key prefix.

Return Value

string

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.