DatabaseStore
class DatabaseStore implements CanFlushLocks, LockProvider, Store (View source)
Traits
Properties
| protected ConnectionInterface | $connection | The database connection instance. |
|
| protected ConnectionInterface | $lockConnection | The database connection instance that should be used to manage locks. |
|
| 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. |
Methods
Get the number of seconds until the given DateTime.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Create a new database store.
Retrieve an item from the cache by key.
Retrieve multiple items from the cache by key.
Store an item in the cache for a given number of seconds.
Store multiple items in the cache for a given number of seconds.
Store an item in the cache if the key doesn't exist.
Increment the value of an item in the cache.
Decrement the value of an item in the cache.
Increment or decrement an item in the cache.
Get the current system time.
Store an item in the cache indefinitely.
Restore a lock instance using the owner identifier.
Adjust the expiration time of a cached item.
Remove an item from the cache.
Remove an item from the cache if it is expired.
Remove all items from the cache.
Remove all expired items from the given set from the cache.
Remove all items from the cache.
Remove all locks from the store.
Get the underlying database connection.
Get the connection used to manage locks.
Specify the connection that should be used to manage locks.
Get the cache key prefix.
Set the cache key prefix.
Serialize the given value.
Unserialize the given value.
Determine if the lock store is separate from the cache store.
Details
protected int
secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int
currentTime()
Get the current system time as a UNIX timestamp.
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
__construct(ConnectionInterface $connection, string $table, string $prefix = '', string $lockTable = 'cache_locks', array $lockLottery = [2, 100], int $defaultLockTimeoutInSeconds = 86400, array|bool|null $serializableClasses = null)
Create a new database store.
mixed
get(string $key)
Retrieve an item from the cache by key.
array
many(array $keys)
Retrieve multiple items from the cache by key.
Items not found in the cache will have a null value.
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.
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.
protected int|false
incrementOrDecrement(string $key, int|float $value, Closure $callback)
Increment or decrement an item in the cache.
protected 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.
protected bool
forgetMany(array $keys)
Remove all items from the cache.
protected 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
flushLocks()
Remove all locks from the store.
protected Builder
table()
Get a query builder for the cache table.
protected Builder
lockTable()
Get a query builder for the cache locks table.
ConnectionInterface
getConnection()
Get the underlying database connection.
$this
setConnection(ConnectionInterface $connection)
Set the underlying database connection.
ConnectionInterface
getLockConnection()
Get the connection used to manage locks.
$this
setLockConnection(ConnectionInterface $connection)
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.
protected string
serialize(mixed $value)
Serialize the given value.
protected mixed
unserialize(string $value)
Unserialize the given value.
bool
hasSeparateLockStore()
Determine if the lock store is separate from the cache store.