TaggedCache
class TaggedCache extends Repository (View source)
Traits
RetrievesMultipleKeys |
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 | $default | The default number of minutes to store items. | from Repository |
protected TagSet | $tags | The tag set instance. |
Methods
static void | macro(string $name, callable $macro) Register a custom macro. | 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. | |
void | setEventDispatcher(Dispatcher $events) Set the event dispatcher instance. | from Repository |
void | fireCacheEvent(string $event, array $payload) Fire an event for this cache instance. | |
bool | has(string $key) Determine if an item exists 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 |
mixed | pull(string $key, mixed $default = null) Retrieve an item from the cache and delete it. | from Repository |
void | put(string $key, mixed $value, DateTime|int $minutes = null) Store an item in the cache. | from Repository |
void | putMany(array $values, int $minutes) Store multiple items in the cache for a given number of minutes. | from RetrievesMultipleKeys |
bool | add(string $key, mixed $value, DateTime|int $minutes) Store an item in the cache if the key does not exist. | from Repository |
void | forever(string $key, mixed $value) Store an item in the cache indefinitely. | from Repository |
mixed | remember(string $key, DateTime|int $minutes, Closure $callback) Get an item from the cache, or store the default value. | from Repository |
mixed | sear(string $key, Closure $callback) Get an item from the cache, or store the default value forever. | from Repository |
mixed | rememberForever(string $key, Closure $callback) Get an item from the cache, or store the default value forever. | from Repository |
bool | forget(string $key) Remove an item from the cache. | 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 | getDefaultCacheTime() Get the default cache time. | from Repository |
void | setDefaultCacheTime(int $minutes) Set the default cache time in minutes. | from Repository |
Store | getStore() Get the cache store implementation. | 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 |
int|null | getMinutes(DateTime|int $duration) Calculate the number of minutes with the given duration. | from Repository |
void | __clone() Clone cache repository instance. | from Repository |
void | increment(string $key, mixed $value = 1) Increment the value of an item in the cache. | |
void | decrement(string $key, mixed $value = 1) Increment the value of an item in the cache. | |
void | flush() Remove all items from the cache. | |
string | taggedItemKey(string $key) Get a fully qualified key for a tagged item. |
Details
static void macro(string $name, callable $macro)
Register a custom macro.
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.
void setEventDispatcher(Dispatcher $events)
Set the event dispatcher instance.
protected void fireCacheEvent(string $event, array $payload)
Fire an event for this 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.
array many(array $keys)
Retrieve multiple items from the cache by key.
Items not found in the cache will have a null value.
mixed pull(string $key, mixed $default = null)
Retrieve an item from the cache and delete it.
void put(string $key, mixed $value, DateTime|int $minutes = null)
Store an item in the cache.
void putMany(array $values, int $minutes)
Store multiple items 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.
void forever(string $key, mixed $value)
Store an item in the cache indefinitely.
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.
bool forget(string $key)
Remove an item from the cache.
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.
int getDefaultCacheTime()
Get the default cache time.
void setDefaultCacheTime(int $minutes)
Set the default cache time in minutes.
Store getStore()
Get the cache store implementation.
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.
protected int|null getMinutes(DateTime|int $duration)
Calculate the number of minutes with the given duration.
void __clone()
Clone cache repository instance.
void increment(string $key, mixed $value = 1)
Increment the value of an item in the cache.
void decrement(string $key, mixed $value = 1)
Increment the value of an item in the cache.
void flush()
Remove all items from the cache.
string taggedItemKey(string $key)
Get a fully qualified key for a tagged item.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Cache/TaggedCache.html