class FailoverStore extends TaggableStore implements LockProvider (View source)

Methods

tags(mixed $names)

Begin executing a new tags operation.

__construct(CacheManager $cache, Dispatcher $events, array $stores)

Create a new failover 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.

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.

bool
forever(string $key, mixed $value)

Store an item in the cache indefinitely.

lock(string $name, int $seconds = 0, string|null $owner = null)

Get a lock instance.

restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

bool
forget(string $key)

Remove an item from the cache.

bool
flush()

Remove all items from the cache.

void
flushStaleTags()

Remove all expired tag set entries.

string
getPrefix()

Get the cache key prefix.

attemptOnAllStores(string $method, array $arguments)

Attempt the given method on all stores.

store(string $store)

Get the cache store for the given store name.

Details

TaggedCache tags(mixed $names)

Begin executing a new tags operation.

Parameters

mixed $names

Return Value

TaggedCache

__construct(CacheManager $cache, Dispatcher $events, array $stores)

Create a new failover store.

Parameters

CacheManager $cache
Dispatcher $events
array $stores

mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

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

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

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

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

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

bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

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

Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Parameters

string $name
string $owner

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

void flushStaleTags()

Remove all expired tag set entries.

Return Value

void

string getPrefix()

Get the cache key prefix.

Return Value

string

protected attemptOnAllStores(string $method, array $arguments)

Attempt the given method on all stores.

Parameters

string $method
array $arguments

protected Repository store(string $store)

Get the cache store for the given store name.

Parameters

string $store

Return Value

Repository