class TaggedCache extends Repository (View source)
RetrievesMultipleKeys | |
InteractsWithTime | |
Macroable |
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. |
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. |
Get the number of seconds until the given DateTime.
Get the "available at" UNIX timestamp.
If the given value is an interval, convert it to a DateTime instance.
Get the current system time as a UNIX timestamp.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Determine if an item exists in the cache.
Determine if an item doesn't exist in the cache.
Retrieve an item from the cache by key.
Retrieve multiple items from the cache by key.
Items not found in the cache will have a null value.
{@inheritdoc}
Handle a result for the "many" method.
Retrieve an item from the cache and delete it.
Store an item in the cache.
{@inheritdoc}
Store multiple items in the cache for a given number of seconds.
Store multiple items in the cache indefinitely.
{@inheritdoc}
Store an item in the cache if the key does not exist.
Increment the value of an item in the cache.
Decrement the value of an item in the cache.
Store an item in the cache indefinitely.
Get an item from the cache, or execute the given Closure and store the result.
Get an item from the cache, or execute the given Closure and store the result forever.
Get an item from the cache, or execute the given Closure and store the result forever.
Remove an item from the cache.
{@inheritdoc}
{@inheritdoc}
{@inheritdoc}
Begin executing a new tags operation if the store supports it.
Format the key for a cache item.
Calculate the number of seconds for the given TTL.
Determine if the current store supports tags.
Get the default cache time.
Set the default cache time in seconds.
Get the cache store implementation.
Fire an event for this cache instance.
Get the event dispatcher instance.
Set the event dispatcher instance.
Determine if a cached value exists.
Retrieve an item from the cache by key.
Store an item in the cache for the default time.
Remove an item from the cache.
Clone cache repository instance.
Remove all items from the cache.
Get a fully qualified key for a tagged item.
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