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

DatabaseStore

class DatabaseStore implements CanFlushLocks, LockProvider, Store

Traits

InteractsWithTime

Constants

DEFAULT_LOCK_TABLE

Properties

protected ConnectionResolverInterface $resolver

The database connection resolver.
protected string|null $connectionName

The connection name.
protected string|null $lockConnectionName

The lock connection name.
protected string $table

The name of the cache table.
protected string $prefix

A string that should be prepended to keys.
protected string $lockTable

The name of the cache locks table.
protected array $lockLottery

An array representation of the lock lottery odds.
protected int $defaultLockTimeoutInSeconds

The default number of seconds that a lock should be held.
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
__construct(ConnectionResolverInterface $resolver, string|null $connectionName, string $table, string $prefix = '', string $lockTable = self::DEFAULT_LOCK_TABLE, array $lockLottery = [2, 100], int $defaultLockTimeoutInSeconds = 86400, array|bool|null $serializableClasses = null, SerializableClassPolicy|null $serializableClassPolicy = null)

Create a new database store.

ConnectionInterface
connection()

Get a fresh connection from the pool.

mixed
get(string $key)

Retrieve an item from the cache by key.

array
many(array $keys)

Retrieve multiple items 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
putMany(array $values, int $seconds)

Store multiple items 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|int
incrementOrDecrement(string $key, int $value, Closure $callback)

Increment or decrement an item in the cache.

int
getTime()

Get the current system time.

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
forgetIfExpired(string $key)

Remove an item from the cache if it is expired.

bool
forgetMany(array $keys)

Remove multiple items from the cache.

bool
forgetManyIfExpired(array $keys, bool $prefixed = false)

Remove all expired items from the given set 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.

int
pruneExpired()

Remove all expired entries from the cache.

Builder
table()

Get a query builder for the cache table.

Builder
lockTable()

Get a query builder for the cache locks table.

ConnectionInterface
getConnection()

Get the underlying database connection.

DatabaseStore
setConnection(string $connectionName)

Set the connection name for the cache store.

ConnectionInterface
getLockConnection()

Get the connection used to manage locks.

DatabaseStore
setLockConnection(string $connectionName)

Specify the connection that should be used to manage locks.

string
getPrefix()

Get the cache key prefix.

void
setPrefix(string $prefix)

Set the cache key prefix.

string
serialize(mixed $value)

Serialize the given value.

mixed
unserialize(string $value)

Unserialize the given value.

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

at line 82
__construct(ConnectionResolverInterface $resolver, string|null $connectionName, string $table, string $prefix = '', string $lockTable = self::DEFAULT_LOCK_TABLE, array $lockLottery = [2, 100], int $defaultLockTimeoutInSeconds = 86400, array|bool|null $serializableClasses = null, SerializableClassPolicy|null $serializableClassPolicy = null)

Create a new database store.

Parameters

ConnectionResolverInterface $resolver
string|null $connectionName
string $table
string $prefix
string $lockTable
array $lockLottery
int $defaultLockTimeoutInSeconds
array|bool|null $serializableClasses
SerializableClassPolicy|null $serializableClassPolicy

at line 107
protected ConnectionInterface connection()

Get a fresh connection from the pool.

Return Value

ConnectionInterface

at line 115
mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

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

at line 166
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 174
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 201
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 217
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 227
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 237
protected bool|int incrementOrDecrement(string $key, int $value, Closure $callback)

Increment or decrement an item in the cache.

Parameters

string $key
int $value
Closure $callback

Return Value

bool|int

at line 279
protected int getTime()

Get the current system time.

Return Value

int

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

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

at line 295
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 312
Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Parameters

string $name
string $owner

Return Value

Lock

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

Adjust the expiration time of a cached item.

Parameters

string $key
int $seconds

Return Value

bool

at line 333
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line 341
bool forgetIfExpired(string $key)

Remove an item from the cache if it is expired.

Parameters

string $key

Return Value

bool

at line 349
protected bool forgetMany(array $keys)

Remove multiple items from the cache.

Parameters

array $keys

Return Value

bool

at line 362
protected bool forgetManyIfExpired(array $keys, bool $prefixed = false)

Remove all expired items from the given set from the cache.

Parameters

array $keys
bool $prefixed

Return Value

bool

at line 381
bool flush()

Remove all items from the cache.

Return Value

bool

at line 391
bool supportsFlushingLocks()

Determine if the store can currently flush locks.

Return Value

bool

at line 401
bool flushLocks()

Remove all locks from the store.

Return Value

bool

Exceptions

RuntimeException

at line 415
int pruneExpired()

Remove all expired entries from the cache.

Return Value

int

at line 425
protected Builder table()

Get a query builder for the cache table.

Return Value

Builder

at line 433
protected Builder lockTable()

Get a query builder for the cache locks table.

Return Value

Builder

at line 441
ConnectionInterface getConnection()

Get the underlying database connection.

Return Value

ConnectionInterface

at line 454
DatabaseStore setConnection(string $connectionName)

Set the connection name for the cache store.

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

Parameters

string $connectionName

Return Value

DatabaseStore

at line 465
ConnectionInterface getLockConnection()

Get the connection used to manage locks.

Return Value

ConnectionInterface

at line 478
DatabaseStore setLockConnection(string $connectionName)

Specify the connection that should be used to manage locks.

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

Parameters

string $connectionName

Return Value

DatabaseStore

at line 489
string getPrefix()

Get the cache key prefix.

Return Value

string

at line 500
void setPrefix(string $prefix)

Set the cache key prefix.

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

Parameters

string $prefix

Return Value

void

at line 509
protected string serialize(mixed $value)

Serialize the given value.

Parameters

mixed $value

Return Value

string

at line 526
protected mixed unserialize(string $value)

Unserialize the given value.

Parameters

string $value

Return Value

mixed

at line 549
bool hasSeparateLockStore()

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

Return Value

bool