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

FileStore

class FileStore implements CanFlushLocks, LockProvider, 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 $files

The Filesystem instance.
protected string $directory

The file cache directory.
protected string|null $lockDirectory

The file cache lock directory.
protected int|null $filePermission

Octal representation of the cache file permissions.
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 $files, string $directory, int|null $filePermission = null, array|bool|null $serializableClasses = null, SerializableClassPolicy|null $serializableClassPolicy = null)

Create a new file 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
refreshIfOwned(string $key, string $expectedOwner, int $seconds)

Atomically refresh the expiration of a cache key if it matches the expected owner.

string|null
getLockOwner(string $key)

Read the owner of a live lock without removing its file.

bool
forgetIfOwned(string $key, string $expectedOwner)

Remove a lock file only while its expected owner holds it.

float|null
remainingSeconds(string $key)

Get the number of seconds until the given key expires.

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.

Lock
lock(string $name, int $seconds = 0, string|null $owner = null)

Get a lock instance.

Lock
restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

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.

bool
supportsFlushingLocks()

Determine if the store can currently flush locks.

bool
flushLocks()

Remove all locks from the store.

Filesystem
getFilesystem()

Get the Filesystem instance.

string
getDirectory()

Get the working directory of the cache.

FileStore
setDirectory(string $directory)

Set the working directory of the cache.

FileStore
setLockDirectory(string|null $lockDirectory)

Set the cache directory where locks should be stored.

string
getPrefix()

Get the cache key prefix.

void
ensureCacheDirectoryExists(string $path)

Create the file cache directory if necessary.

void
ensurePermissionsAreCorrect(string $path)

Ensure the created node has the correct permissions.

bool
putWithExpiresAt(string $key, mixed $value, int $expiresAt)

Store an item with an absolute expiration timestamp.

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
expiresAtHeader(int $expiresAt)

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

bool
hasSeparateLockStore()

Determine if the lock store is separate from the cache store.

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 47
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 63
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 71
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 25
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 44
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 62
__construct(Filesystem $files, string $directory, int|null $filePermission = null, array|bool|null $serializableClasses = null, SerializableClassPolicy|null $serializableClassPolicy = null)

Create a new file cache store instance.

Parameters

Filesystem $files
string $directory
int|null $filePermission
array|bool|null $serializableClasses
SerializableClassPolicy|null $serializableClassPolicy

at line 79
mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

at line 87
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 95
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 136
bool refreshIfOwned(string $key, string $expectedOwner, int $seconds)

Atomically refresh the expiration of a cache key if it matches the expected owner.

Parameters

string $key
string $expectedOwner
int $seconds

Return Value

bool

at line 186
string|null getLockOwner(string $key)

Read the owner of a live lock without removing its file.

Parameters

string $key

Return Value

string|null

at line 208
bool forgetIfOwned(string $key, string $expectedOwner)

Remove a lock file only while its expected owner holds it.

Parameters

string $key
string $expectedOwner

Return Value

bool

at line 241
float|null remainingSeconds(string $key)

Get the number of seconds until the given key expires.

Parameters

string $key

Return Value

float|null

at line 265
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 284
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 292
bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

at line 300
Lock lock(string $name, int $seconds = 0, string|null $owner = null)

Get a lock instance.

Parameters

string $name
int $seconds
string|null $owner

Return Value

Lock

at line 321
Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Parameters

string $name
string $owner

Return Value

Lock

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

Adjust the expiration time of a cached item.

Parameters

string $key
int $seconds

Return Value

bool

at line 343
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line 359
bool flush()

Remove all items from the cache.

Return Value

bool

at line 379
bool supportsFlushingLocks()

Determine if the store can currently flush locks.

Return Value

bool

at line 389
bool flushLocks()

Remove all locks from the store.

Return Value

bool

Exceptions

RuntimeException

at line 413
Filesystem getFilesystem()

Get the Filesystem instance.

Return Value

Filesystem

at line 421
string getDirectory()

Get the working directory of the cache.

Return Value

string

at line 434
FileStore setDirectory(string $directory)

Set the working directory of the cache.

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

Parameters

string $directory

Return Value

FileStore

at line 450
FileStore setLockDirectory(string|null $lockDirectory)

Set the cache directory where locks should be stored.

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

Parameters

string|null $lockDirectory

Return Value

FileStore

at line 461
string getPrefix()

Get the cache key prefix.

Return Value

string

at line 469
protected void ensureCacheDirectoryExists(string $path)

Create the file cache directory if necessary.

Parameters

string $path

Return Value

void

at line 485
protected void ensurePermissionsAreCorrect(string $path)

Ensure the created node has the correct permissions.

Parameters

string $path

Return Value

void

at line 498
protected bool putWithExpiresAt(string $key, mixed $value, int $expiresAt)

Store an item with an absolute expiration timestamp.

Parameters

string $key
mixed $value
int $expiresAt

Return Value

bool

at line 522
protected array getPayload(string $key)

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

Parameters

string $key

Return Value

array

at line 575
protected mixed unserialize(string $value)

Unserialize the given value.

Parameters

string $value

Return Value

mixed

at line 593
protected array emptyPayload()

Get a default empty payload for the cache.

Return Value

array

at line 601
string path(string $key)

Get the full path for the given cache key.

Parameters

string $key

Return Value

string

at line 611
protected int expiration(int $seconds)

Get the expiration time based on the given seconds.

Parameters

int $seconds

Return Value

int

at line 621
protected string expiresAtHeader(int $expiresAt)

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

Parameters

int $expiresAt

Return Value

string

at line 629
bool hasSeparateLockStore()

Determine if the lock store is separate from the cache store.

Return Value

bool