1. class
  2. Hypervel
  3. \
  4. Cache
  5. \
  6. StorageStore

StorageStore

class StorageStore implements Store

Traits

InteractsWithTime
RetrievesMultipleKeys

Fallback implementations for stores without native multi-key operations.

Constants

protected PERMANENT_TIMESTAMP

The expiration timestamp stored for items cached forever.

Properties

protected Filesystem $disk

The filesystem disk instance.
protected string $directory

The storage path where cache files should be written.
protected string $prefix

A string that should be prepended to keys.
protected array|bool|null $serializableClasses

The classes that should be allowed during unserialization.
protected SerializableClassPolicy|null $serializableClassPolicy

The shared serializable class policy.

Methods

int
secondsUntil(DateInterval|DateTimeInterface|int $delay)

Get the number of seconds until the given DateTime.

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

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateInterval|DateTimeInterface|int|null $delay)

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

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

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

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

from  InteractsWithTime
array
many(array $keys)

Retrieve multiple items from the cache by key.

from  RetrievesMultipleKeys
bool
putMany(array $values, int $seconds)

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

from  RetrievesMultipleKeys
__construct(Filesystem $disk, string $directory = '', string $prefix = '', array|bool|null $serializableClasses = null, SerializableClassPolicy|null $serializableClassPolicy = null)

Create a new storage cache store instance.

mixed
get(string $key)

Retrieve an item from the cache by key.

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

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

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

Store an item in the cache if the key doesn't exist.

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.

array
getPayload(string $key)

Retrieve an item and expiry time from the cache by key.

mixed
unserialize(string $value)

Unserialize the given value.

array
emptyPayload()

Get a default empty payload for the cache.

string
path(string $key)

Get the full path for the given cache key.

int
expiration(int $seconds)

Get the expiration time based on the given seconds.

string
expirationHeader(int $seconds)

Get the fixed-width expiration header for a cache item.

Filesystem
getDisk()

Get the filesystem disk instance.

string
getDirectory()

Get the working directory of the cache.

string
getPrefix()

Get the cache key prefix.

void
setPrefix(string $prefix)

Set 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

in RetrievesMultipleKeys at line 21
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

in RetrievesMultipleKeys at line 40
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 50
__construct(Filesystem $disk, string $directory = '', string $prefix = '', array|bool|null $serializableClasses = null, SerializableClassPolicy|null $serializableClassPolicy = null)

Create a new storage cache store instance.

Parameters

Filesystem $disk
string $directory
string $prefix
array|bool|null $serializableClasses
SerializableClassPolicy|null $serializableClassPolicy

at line 67
mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

at line 75
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
bool add(string $key, mixed $value, int $seconds)

Store an item in the cache if the key doesn't exist.

Parameters

string $key
mixed $value
int $seconds

Return Value

bool

at line 98
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 110
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 118
bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

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

Adjust the expiration time of a cached item.

Parameters

string $key
int $seconds

Return Value

bool

at line 140
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line 154
bool flush()

Remove all items from the cache.

Return Value

bool

at line 169
protected array getPayload(string $key)

Retrieve an item and expiry time from the cache by key.

Parameters

string $key

Return Value

array

at line 204
protected mixed unserialize(string $value)

Unserialize the given value.

Parameters

string $value

Return Value

mixed

at line 220
protected array emptyPayload()

Get a default empty payload for the cache.

Return Value

array

at line 228
string path(string $key)

Get the full path for the given cache key.

Parameters

string $key

Return Value

string

at line 238
protected int expiration(int $seconds)

Get the expiration time based on the given seconds.

Parameters

int $seconds

Return Value

int

at line 248
protected string expirationHeader(int $seconds)

Get the fixed-width expiration header for a cache item.

Parameters

int $seconds

Return Value

string

at line 256
Filesystem getDisk()

Get the filesystem disk instance.

Return Value

Filesystem

at line 264
string getDirectory()

Get the working directory of the cache.

Return Value

string

at line 272
string getPrefix()

Get the cache key prefix.

Return Value

string

at line 283
void setPrefix(string $prefix)

Set the cache key prefix.

Boot-only. Persists on the cached store for the worker lifetime; per-request use races across coroutines.

Parameters

string $prefix

Return Value

void