1. class
  2. Illuminate
  3. \
  4. Cache
  5. \
  6. RedisTaggedCache

RedisTaggedCache

class RedisTaggedCache extends TaggedCache (View source)

Traits

RetrievesMultipleKeys
InteractsWithTime
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Store $store

The cache store implementation.

 from  Repository
protected Dispatcher|null $events

The event dispatcher implementation.

 from  Repository
protected int|null $default

The default number of seconds to store items.

 from  Repository
protected array $config

The cache store configuration options.

 from  Repository
protected TagSet $tags

The tag set instance.

 from  TaggedCache

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

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

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
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(Store $store, TagSet $tags)

Create a new tagged cache instance.

from  TaggedCache
bool
has(array|string $key)

Determine if an item exists in the cache.

from  Repository
bool
missing(string $key)

Determine if an item doesn't exist in the cache.

from  Repository
mixed
get(array|string $key, mixed $default = null)

Retrieve an item from the cache by key.

from  Repository
array
many(array $keys)

Retrieve multiple items from the cache by key.

from  RetrievesMultipleKeys
iterable
getMultiple($keys, $default = null)

{@inheritdoc}

from  Repository
mixed
handleManyResult(array $keys, string $key, mixed $value)

Handle a result for the "many" method.

from  Repository
pull($key, $default = null)

Retrieve an item from the cache and delete it.

from  Repository
bool
put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

Store an item in the cache.

bool
set($key, $value, $ttl = null)

{@inheritdoc}

from  Repository
bool
putMany(array $values, int $seconds)

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

from  RetrievesMultipleKeys
bool
putManyForever(array $values)

Store multiple items in the cache indefinitely.

from  Repository
bool
setMultiple($values, $ttl = null)

{@inheritdoc}

from  Repository
bool
add(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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)

Decrement the value of an item in the cache.

bool
forever(string $key, mixed $value)

Store an item in the cache indefinitely.

remember($key, $ttl, Closure $callback)

No description

from  Repository
sear($key, Closure $callback)

No description

from  Repository
rememberForever($key, Closure $callback)

No description

from  Repository
flexible($key, $ttl, $callback, $lock = null)

No description

from  Repository
bool
forget(string $key)

Remove an item from the cache.

from  Repository
bool
delete($key)

{@inheritdoc}

from  Repository
bool
deleteMultiple($keys)

{@inheritdoc}

from  Repository
bool
clear()

{@inheritdoc}

from  Repository
TaggedCache
tags(array|mixed $names)

Begin executing a new tags operation if the store supports it.

from  Repository
string
itemKey(string $key)

Format the key for a cache item.

from  TaggedCache
int
getSeconds(DateTimeInterface|DateInterval|int $ttl)

Calculate the number of seconds for the given TTL.

from  Repository
string|null
getName()

Get the name of the cache store.

from  Repository
bool
supportsTags()

Determine if the current store supports tags.

from  Repository
int|null
getDefaultCacheTime()

Get the default cache time.

from  Repository
$this
setDefaultCacheTime(int|null $seconds)

Set the default cache time in seconds.

from  Repository
Store
getStore()

Get the cache store implementation.

from  Repository
Repository
setStore(Store $store)

Set the cache store implementation.

from  Repository
void
event(object|string $event)

Fire an event for this cache instance.

from  TaggedCache
Dispatcher|null
getEventDispatcher()

Get the event dispatcher instance.

from  Repository
void
setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance.

from  Repository
bool
offsetExists(string $key)

Determine if a cached value exists.

from  Repository
mixed
offsetGet(string $key)

Retrieve an item from the cache by key.

from  Repository
void
offsetSet(string $key, mixed $value)

Store an item in the cache for the default time.

from  Repository
void
offsetUnset(string $key)

Remove an item from the cache.

from  Repository
void
__clone()

Clone cache repository instance.

from  Repository
bool
flush()

Remove all items from the cache.

string
taggedItemKey(string $key)

Get a fully qualified key for a tagged item.

from  TaggedCache
TagSet
getTags()

Get the tag set instance.

from  TaggedCache
void
flushValues()

Flush the individual cache entries for the tags.

bool
flushStale()

Remove all stale reference entries from the tag set.

Details

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
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

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in TaggedCache at line 26
__construct(Store $store, TagSet $tags)

Create a new tagged cache instance.

Parameters

Store $store
TagSet $tags

in Repository at line 85
bool has(array|string $key)

Determine if an item exists in the cache.

Parameters

array|string $key

Return Value

bool

in Repository at line 96
bool missing(string $key)

Determine if an item doesn't exist in the cache.

Parameters

string $key

Return Value

bool

in Repository at line 108
mixed get(array|string $key, mixed $default = null)

Retrieve an item from the cache by key.

Parameters

array|string $key
mixed $default

Return Value

mixed

in RetrievesMultipleKeys at line 17
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

in Repository at line 160
iterable getMultiple($keys, $default = null)

{@inheritdoc}

Parameters

$keys
$default

Return Value

iterable

in Repository at line 179
protected mixed handleManyResult(array $keys, string $key, mixed $value)

Handle a result for the "many" method.

Parameters

array $keys
string $key
mixed $value

Return Value

mixed

in Repository at line 205
pull($key, $default = null)

Retrieve an item from the cache and delete it.

Parameters

$key
$default

at line 41
bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

Store an item in the cache.

Parameters

string $key
mixed $value
DateTimeInterface|DateInterval|int|null $ttl

Return Value

bool

in Repository at line 254
bool set($key, $value, $ttl = null)

{@inheritdoc}

Parameters

$key
$value
$ttl

Return Value

bool

in RetrievesMultipleKeys at line 40
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

in Repository at line 299
protected bool putManyForever(array $values)

Store multiple items in the cache indefinitely.

Parameters

array $values

Return Value

bool

in Repository at line 317
bool setMultiple($values, $ttl = null)

{@inheritdoc}

Parameters

$values
$ttl

Return Value

bool

at line 15
bool add(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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

Parameters

string $key
mixed $value
DateTimeInterface|DateInterval|int|null $ttl

Return Value

bool

at line 66
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

at line 80
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

at line 94
bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

in Repository at line 417
remember($key, $ttl, Closure $callback)

No description

Parameters

$key
$ttl
Closure $callback

in Repository at line 444
sear($key, Closure $callback)

No description

Parameters

$key
Closure $callback

in Repository at line 458
rememberForever($key, Closure $callback)

No description

Parameters

$key
Closure $callback

in Repository at line 485
flexible($key, $ttl, $callback, $lock = null)

No description

Parameters

$key
$ttl
$callback
$lock

in Repository at line 531
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

in Repository at line 549
bool delete($key)

{@inheritdoc}

Parameters

$key

Return Value

bool

in Repository at line 559
bool deleteMultiple($keys)

{@inheritdoc}

Parameters

$keys

Return Value

bool

in Repository at line 577
bool clear()

{@inheritdoc}

Return Value

bool

in Repository at line 590
TaggedCache tags(array|mixed $names)

Begin executing a new tags operation if the store supports it.

Parameters

array|mixed $names

Return Value

TaggedCache

Exceptions

BadMethodCallException

in TaggedCache at line 88
protected string itemKey(string $key)

Format the key for a cache item.

Parameters

string $key

Return Value

string

in Repository at line 624
protected int getSeconds(DateTimeInterface|DateInterval|int $ttl)

Calculate the number of seconds for the given TTL.

Parameters

DateTimeInterface|DateInterval|int $ttl

Return Value

int

in Repository at line 642
string|null getName()

Get the name of the cache store.

Return Value

string|null

in Repository at line 652
bool supportsTags()

Determine if the current store supports tags.

Return Value

bool

in Repository at line 662
int|null getDefaultCacheTime()

Get the default cache time.

Return Value

int|null

in Repository at line 673
$this setDefaultCacheTime(int|null $seconds)

Set the default cache time in seconds.

Parameters

int|null $seconds

Return Value

$this

in Repository at line 685
Store getStore()

Get the cache store implementation.

Return Value

Store

in Repository at line 696
Repository setStore(Store $store)

Set the cache store implementation.

Parameters

Store $store

Return Value

Repository

in TaggedCache at line 110
protected void event(object|string $event)

Fire an event for this cache instance.

Parameters

object|string $event

Return Value

void

in Repository at line 719
Dispatcher|null getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher|null

in Repository at line 730
void setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance.

Parameters

Dispatcher $events

Return Value

void

in Repository at line 741
bool offsetExists(string $key)

Determine if a cached value exists.

Parameters

string $key

Return Value

bool

in Repository at line 752
mixed offsetGet(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

in Repository at line 764
void offsetSet(string $key, mixed $value)

Store an item in the cache for the default time.

Parameters

string $key
mixed $value

Return Value

void

in Repository at line 775
void offsetUnset(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

void

in Repository at line 801
void __clone()

Clone cache repository instance.

Return Value

void

at line 106
bool flush()

Remove all items from the cache.

Return Value

bool

in TaggedCache at line 99
string taggedItemKey(string $key)

Get a fully qualified key for a tagged item.

Parameters

string $key

Return Value

string

in TaggedCache at line 120
TagSet getTags()

Get the tag set instance.

Return Value

TagSet

at line 119
protected void flushValues()

Flush the individual cache entries for the tags.

Return Value

void

at line 135
bool flushStale()

Remove all stale reference entries from the tag set.

Return Value

bool