TaggedCache
class TaggedCache extends Repository (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 | $events | The event dispatcher implementation. | from Repository |
| protected int|null | $default | The default number of seconds to store items. | from Repository |
| protected TagSet | $tags | The tag set instance. |
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 |
| 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 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 |
| void | __construct(Store $store, TagSet $tags) Create a new tagged cache instance. | |
| bool | has(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(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 |
| getMultiple($keys, $default = null) {@inheritdoc} | from Repository | |
| mixed | handleManyResult(array $keys, string $key, mixed $value) Handle a result for the "many" method. | from Repository |
| mixed | pull(string $key, mixed $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. | from Repository |
| set($key, $value, $ttl = null) {@inheritdoc} | from Repository | |
| bool | putMany(array $values, DateTimeInterface|DateInterval|int|null $ttl = null) Store multiple items in the cache for a given number of seconds. | |
| bool | putManyForever(array $values) Store multiple items in the cache indefinitely. | from Repository |
| 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. | from Repository |
| 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. | from Repository |
| mixed | remember(string $key, DateTimeInterface|DateInterval|int|null $ttl, Closure $callback) Get an item from the cache, or execute the given Closure and store the result. | from Repository |
| mixed | sear(string $key, Closure $callback) Get an item from the cache, or execute the given Closure and store the result forever. | from Repository |
| mixed | rememberForever(string $key, Closure $callback) Get an item from the cache, or execute the given Closure and store the result forever. | from Repository |
| bool | forget(string $key) Remove an item from the cache. | from Repository |
| delete($key) {@inheritdoc} | from Repository | |
| deleteMultiple($keys) {@inheritdoc} | from Repository | |
| 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. | |
| int | getSeconds(DateTimeInterface|DateInterval|int $ttl) Calculate the number of seconds for the given TTL. | 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 |
| void | event(string $event) Fire an event for this cache instance. | |
| Dispatcher | 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. | |
| TagSet | getTags() Get the tag set instance. |
Details
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int currentTime()
Get the current system time as a UNIX timestamp.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
bool has(string $key)
Determine if an item exists in the cache.
bool missing(string $key)
Determine if an item doesn't exist in the cache.
mixed get(string $key, mixed $default = null)
Retrieve an item from the cache by key.
array many(array $keys)
Retrieve multiple items from the cache by key.
Items not found in the cache will have a null value.
getMultiple($keys, $default = null)
{@inheritdoc}
protected mixed handleManyResult(array $keys, string $key, mixed $value)
Handle a result for the "many" method.
mixed pull(string $key, mixed $default = null)
Retrieve an item from the cache and delete it.
bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)
Store an item in the cache.
set($key, $value, $ttl = null)
{@inheritdoc}
bool putMany(array $values, DateTimeInterface|DateInterval|int|null $ttl = null)
Store multiple items in the cache for a given number of seconds.
protected bool putManyForever(array $values)
Store multiple items in the cache indefinitely.
setMultiple($values, $ttl = null)
{@inheritdoc}
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.
mixed remember(string $key, DateTimeInterface|DateInterval|int|null $ttl, Closure $callback)
Get an item from the cache, or execute the given Closure and store the result.
mixed sear(string $key, Closure $callback)
Get an item from the cache, or execute the given Closure and store the result forever.
mixed rememberForever(string $key, Closure $callback)
Get an item from the cache, or execute the given Closure and store the result forever.
bool forget(string $key)
Remove an item from the cache.
delete($key)
{@inheritdoc}
deleteMultiple($keys)
{@inheritdoc}
clear()
{@inheritdoc}
TaggedCache tags(array|mixed $names)
Begin executing a new tags operation if the store supports it.
protected string itemKey(string $key)
Format the key for a cache item.
protected int getSeconds(DateTimeInterface|DateInterval|int $ttl)
Calculate the number of seconds for the given TTL.
bool supportsTags()
Determine if the current store supports tags.
int|null getDefaultCacheTime()
Get the default cache time.
$this setDefaultCacheTime(int|null $seconds)
Set the default cache time in seconds.
Store getStore()
Get the cache store implementation.
protected void event(string $event)
Fire an event for this cache instance.
Dispatcher getEventDispatcher()
Get the event dispatcher instance.
void setEventDispatcher(Dispatcher $events)
Set the event dispatcher instance.
bool offsetExists(string $key)
Determine if a cached value exists.
mixed offsetGet(string $key)
Retrieve an item from the cache by key.
void offsetSet(string $key, mixed $value)
Store an item in the cache for the default time.
void offsetUnset(string $key)
Remove an item from the cache.
void __clone()
Clone cache repository instance.
bool flush()
Remove all items from the cache.
string taggedItemKey(string $key)
Get a fully qualified key for a tagged item.
TagSet getTags()
Get the tag set instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Cache/TaggedCache.html