DatabaseStore

class DatabaseStore implements Store (View source)

Traits

InteractsWithTime
RetrievesMultipleKeys

Properties

protected ConnectionInterface $connection The database connection instance.
protected string $table The name of the cache table.
protected string $prefix A string that should be prepended to keys.

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $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
array many(array $keys)

Retrieve multiple items from the cache by key.

 from RetrievesMultipleKeys
void putMany(array $values, float|int $minutes)

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

 from RetrievesMultipleKeys
void __construct(ConnectionInterface $connection, string $table, string $prefix = '')

Create a new database store.
mixed get(string|array $key)

Retrieve an item from the cache by key.
void put(string $key, mixed $value, float|int $minutes)

Store an item in the cache for a given number of minutes.
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.
int|bool incrementOrDecrement(string $key, mixed $value, Closure $callback)

Increment or decrement an item in the cache.
int getTime()

Get the current system time.
void forever(string $key, mixed $value)

Store an item in the cache indefinitely.
bool forget(string $key)

Remove an item from the cache.
bool flush()

Remove all items from the cache.
Builder table()

Get a query builder for the cache table.
ConnectionInterface getConnection()

Get the underlying database connection.
string getPrefix()

Get the cache key prefix.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

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

void putMany(array $values, float|int $minutes)

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

Parameters

array $values
float|int $minutes

Return Value

void

void __construct(ConnectionInterface $connection, string $table, string $prefix = '')

Create a new database store.

Parameters

ConnectionInterface $connection
string $table
string $prefix

Return Value

void

mixed get(string|array $key)

Retrieve an item from the cache by key.

Parameters

string|array $key

Return Value

mixed

void put(string $key, mixed $value, float|int $minutes)

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

Parameters

string $key
mixed $value
float|int $minutes

Return Value

void

int|bool increment(string $key, mixed $value = 1)

Increment the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

int|bool decrement(string $key, mixed $value = 1)

Decrement the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

protected int|bool incrementOrDecrement(string $key, mixed $value, Closure $callback)

Increment or decrement an item in the cache.

Parameters

string $key
mixed $value
Closure $callback

Return Value

int|bool

protected int getTime()

Get the current system time.

Return Value

int

void forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

void

bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

bool flush()

Remove all items from the cache.

Return Value

bool

protected Builder table()

Get a query builder for the cache table.

Return Value

Builder

ConnectionInterface getConnection()

Get the underlying database connection.

Return Value

ConnectionInterface

string getPrefix()

Get the cache key prefix.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Cache/DatabaseStore.html