DatabaseStore
in package
implements
Store
Uses
InteractsWithTime, RetrievesMultipleKeys
Interfaces, Classes and Traits
Table of Contents
- $connection : ConnectionInterface
- The database connection instance.
- $prefix : string
- A string that should be prepended to keys.
- $table : string
- The name of the cache table.
- __construct() : void
- Create a new database store.
- decrement() : int|bool
- Decrement the value of an item in the cache.
- flush() : bool
- Remove all items from the cache.
- forever() : void
- Store an item in the cache indefinitely.
- forget() : bool
- Remove an item from the cache.
- get() : mixed
- Retrieve an item from the cache by key.
- getConnection() : ConnectionInterface
- Get the underlying database connection.
- getPrefix() : string
- Get the cache key prefix.
- increment() : int|bool
- Increment the value of an item in the cache.
- many() : array<string|int, mixed>
- Retrieve multiple items from the cache by key.
- put() : void
- Store an item in the cache for a given number of minutes.
- putMany() : void
- Store multiple items in the cache for a given number of minutes.
- availableAt() : int
- Get the "available at" UNIX timestamp.
- currentTime() : int
- Get the current system time as a UNIX timestamp.
- getTime() : int
- Get the current system time.
- incrementOrDecrement() : int|bool
- Increment or decrement an item in the cache.
- parseDateInterval() : DateTimeInterface|int
- If the given value is an interval, convert it to a DateTime instance.
- secondsUntil() : int
- Get the number of seconds until the given DateTime.
- serialize() : string
- Serialize the given value.
- table() : Builder
- Get a query builder for the cache table.
- unserialize() : mixed
- Unserialize the given value.
Properties
$connection
The database connection instance.
protected
ConnectionInterface
$connection
$prefix
A string that should be prepended to keys.
protected
string
$prefix
$table
The name of the cache table.
protected
string
$table
Methods
__construct()
Create a new database store.
public
__construct(ConnectionInterface $connection, string $table[, string $prefix = '' ]) : void
Parameters
- $connection : ConnectionInterface
- $table : string
- $prefix : string = ''
Return values
void —decrement()
Decrement the value of an item in the cache.
public
decrement(string $key[, mixed $value = 1 ]) : int|bool
Parameters
- $key : string
- $value : mixed = 1
Return values
int|bool —flush()
Remove all items from the cache.
public
flush() : bool
Return values
bool —forever()
Store an item in the cache indefinitely.
public
forever(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
Return values
void —forget()
Remove an item from the cache.
public
forget(string $key) : bool
Parameters
- $key : string
Return values
bool —get()
Retrieve an item from the cache by key.
public
get(string|array<string|int, mixed> $key) : mixed
Parameters
- $key : string|array<string|int, mixed>
Return values
mixed —getConnection()
Get the underlying database connection.
public
getConnection() : ConnectionInterface
Return values
ConnectionInterface —getPrefix()
Get the cache key prefix.
public
getPrefix() : string
Return values
string —increment()
Increment the value of an item in the cache.
public
increment(string $key[, mixed $value = 1 ]) : int|bool
Parameters
- $key : string
- $value : mixed = 1
Return values
int|bool —many()
Retrieve multiple items from the cache by key.
public
many(array<string|int, mixed> $keys) : array<string|int, mixed>
Items not found in the cache will have a null value.
Parameters
- $keys : array<string|int, mixed>
Return values
array<string|int, mixed> —put()
Store an item in the cache for a given number of minutes.
public
put(string $key, mixed $value, float|int $minutes) : void
Parameters
- $key : string
- $value : mixed
- $minutes : float|int
Return values
void —putMany()
Store multiple items in the cache for a given number of minutes.
public
putMany(array<string|int, mixed> $values, float|int $minutes) : void
Parameters
- $values : array<string|int, mixed>
- $minutes : float|int
Return values
void —availableAt()
Get the "available at" UNIX timestamp.
protected
availableAt(DateTimeInterface|DateInterval|int $delay) : int
Parameters
- $delay : DateTimeInterface|DateInterval|int
Return values
int —currentTime()
Get the current system time as a UNIX timestamp.
protected
currentTime() : int
Return values
int —getTime()
Get the current system time.
protected
getTime() : int
Return values
int —incrementOrDecrement()
Increment or decrement an item in the cache.
protected
incrementOrDecrement(string $key, mixed $value, Closure $callback) : int|bool
Parameters
- $key : string
- $value : mixed
- $callback : Closure
Return values
int|bool —parseDateInterval()
If the given value is an interval, convert it to a DateTime instance.
protected
parseDateInterval(DateTimeInterface|DateInterval|int $delay) : DateTimeInterface|int
Parameters
- $delay : DateTimeInterface|DateInterval|int
Return values
DateTimeInterface|int —secondsUntil()
Get the number of seconds until the given DateTime.
protected
secondsUntil(DateTimeInterface|DateInterval|int $delay) : int
Parameters
- $delay : DateTimeInterface|DateInterval|int
Return values
int —serialize()
Serialize the given value.
protected
serialize(mixed $value) : string
Parameters
- $value : mixed
Return values
string —table()
Get a query builder for the cache table.
protected
table() : Builder
Return values
Builder —unserialize()
Unserialize the given value.
protected
unserialize(string $value) : mixed
Parameters
- $value : string