class SessionStore implements Store

Traits

Fallback implementations for stores without native multi-key operations.

Methods

int
secondsUntil(DateInterval|DateTimeInterface|int $delay)

Get the number of seconds until the given DateTime.

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

Get the "available at" UNIX timestamp.

parseDateInterval(DateInterval|DateTimeInterface|int|null $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
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.

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

Increment the value of an item in the cache.

bool|int
decrement(string $key, int $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(string $key)

Get the item key for the given key.

string
getPrefix()

Get the cache key prefix.

Details

in InteractsWithTime at line 17
protected int secondsUntil(DateInterval|DateTimeInterface|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateInterval|DateTimeInterface|int $delay

Return Value

int

in InteractsWithTime at line 29
protected int availableAt(DateInterval|DateTimeInterface|int|null $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateInterval|DateTimeInterface|int|null $delay

Return Value

int

in InteractsWithTime at line 41
protected DateTimeInterface|int parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)

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

Parameters

DateInterval|DateTimeInterface|int|null $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 57
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 65
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

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

Create a new session cache store.

Parameters

Session $session
string $key

at line 31
array all()

Get all of the cached values and their expiration times.

Return Value

array

at line 39
mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

at line 62
protected bool isExpired(int|float $expiresAt)

Determine if the given expiration time is expired.

Parameters

int|float $expiresAt

Return Value

bool

at line 70
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

at line 86
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

at line 94
bool|int increment(string $key, int $value = 1)

Increment the value of an item in the cache.

Parameters

string $key
int $value

Return Value

bool|int

at line 113
bool|int decrement(string $key, int $value = 1)

Decrement the value of an item in the cache.

Parameters

string $key
int $value

Return Value

bool|int

at line 121
bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

at line 129
bool touch(string $key, int $seconds)

Adjust the expiration time of a cached item.

Parameters

string $key
int $seconds

Return Value

bool

at line 145
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line 163
bool flush()

Remove all items from the cache.

Return Value

bool

at line 173
string itemKey(string $key)

Get the item key for the given key.

Parameters

string $key

Return Value

string

at line 181
string getPrefix()

Get the cache key prefix.

Return Value

string