class MemcachedStore extends TaggableStore implements LockProvider, Store (View source)

Traits

Properties

protected Memcached $memcached The Memcached instance.
protected string $prefix A string that should be prepended to keys.
protected bool $onVersionThree Indicates whether we are using Memcached version >= 3.0.0.

Methods

tags(array|mixed $names)

Begin executing a new tags operation.

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

int
currentTime()

Get the current system time as a UNIX timestamp.

void
__construct(Memcached $memcached, string $prefix = '')

Create a new Memcached store.

mixed
get(string|array $key)

Retrieve an item from the cache by key.

array
many(array $keys)

Retrieve multiple items 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.

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

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

bool
add(string $key, mixed $value, float|int $minutes)

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.

void
forever(string $key, mixed $value)

Store an item in the cache indefinitely.

lock(string $name, int $seconds = 0)

Get a lock instance.

bool
forget(string $key)

Remove an item from the cache.

bool
flush()

Remove all items from the cache.

int
toTimestamp(int $minutes)

Get the UNIX timestamp for the given number of minutes.

Memcached
getMemcached()

Get the underlying Memcached connection.

string
getPrefix()

Get the cache key prefix.

void
setPrefix(string $prefix)

Set the cache key prefix.

Details

TaggedCache tags(array|mixed $names)

Begin executing a new tags operation.

Parameters

array|mixed $names

Return Value

TaggedCache

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 = 0)

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

void __construct(Memcached $memcached, string $prefix = '')

Create a new Memcached store.

Parameters

Memcached $memcached
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

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 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

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

bool add(string $key, mixed $value, float|int $minutes)

Store an item in the cache if the key doesn't exist.

Parameters

string $key
mixed $value
float|int $minutes

Return Value

bool

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

void forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

void

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

Get a lock instance.

Parameters

string $name
int $seconds

Return Value

Lock

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 int toTimestamp(int $minutes)

Get the UNIX timestamp for the given number of minutes.

Parameters

int $minutes

Return Value

int

Memcached getMemcached()

Get the underlying Memcached connection.

Return Value

Memcached

string getPrefix()

Get the cache key prefix.

Return Value

string

void setPrefix(string $prefix)

Set the cache key prefix.

Parameters

string $prefix

Return Value

void