TaggedCache

class TaggedCache implements StoreInterface (View source)

Properties

protected StoreInterface $store The cache store implementation.
protected TagSet $tags The tag set instance.

Methods

void __construct(StoreInterface $store, TagSet $tags)

Create a new tagged cache instance.
bool has(string $key)

Determine if an item exists in the cache.
mixed get(string $key, mixed $default = null)

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

Store an item in the cache for a given number of minutes.
bool add(string $key, mixed $value, DateTime|int $minutes)

Store an item in the cache if the key does not 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)

Increment the value of an item in the cache.
void forever(string $key, mixed $value)

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

Remove an item from the cache.
void flush()

Remove all items from the cache.
mixed remember(string $key, DateTime|int $minutes, Closure $callback)

Get an item from the cache, or store the default value.
mixed sear(string $key, Closure $callback)

Get an item from the cache, or store the default value forever.
mixed rememberForever(string $key, Closure $callback)

Get an item from the cache, or store the default value forever.
string taggedItemKey(string $key)

Get a fully qualified key for a tagged item.
string getPrefix()

Get the cache key prefix.
int|null getMinutes(DateTime|int $duration)

Calculate the number of minutes with the given duration.

Details

void __construct(StoreInterface $store, TagSet $tags)

Create a new tagged cache instance.

Parameters

StoreInterface $store
TagSet $tags

Return Value

void

bool has(string $key)

Determine if an item exists in the cache.

Parameters

string $key

Return Value

bool

mixed get(string $key, mixed $default = null)

Retrieve an item from the cache by key.

Parameters

string $key
mixed $default

Return Value

mixed

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

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

Parameters

string $key
mixed $value
int $minutes

Return Value

void

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

Store an item in the cache if the key does not exist.

Parameters

string $key
mixed $value
DateTime|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)

Increment 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

void forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

void

void flush()

Remove all items from the cache.

Return Value

void

mixed remember(string $key, DateTime|int $minutes, Closure $callback)

Get an item from the cache, or store the default value.

Parameters

string $key
DateTime|int $minutes
Closure $callback

Return Value

mixed

mixed sear(string $key, Closure $callback)

Get an item from the cache, or store the default value forever.

Parameters

string $key
Closure $callback

Return Value

mixed

mixed rememberForever(string $key, Closure $callback)

Get an item from the cache, or store the default value forever.

Parameters

string $key
Closure $callback

Return Value

mixed

string taggedItemKey(string $key)

Get a fully qualified key for a tagged item.

Parameters

string $key

Return Value

string

string getPrefix()

Get the cache key prefix.

Return Value

string

protected int|null getMinutes(DateTime|int $duration)

Calculate the number of minutes with the given duration.

Parameters

DateTime|int $duration

Return Value

int|null

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