class Repository implements Repository, ArrayAccess (View source)

Traits

Properties

static protected array $macros The registered string macros. from Macroable
protected Store $store The cache store implementation.
protected Dispatcher $events The event dispatcher implementation.
protected float|int $default The default number of minutes to store items.

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)

Handle dynamic calls into macros or pass missing methods to the store.

void
__construct(Store $store)

Create a new cache repository instance.

void
setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance.

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.

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

Retrieve an item from the cache and delete it.

void
put(string $key, mixed $value, DateTime|float|int $minutes = null)

Store an item in the cache.

void
putMany(array $values, float|int $minutes)

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

bool
add(string $key, mixed $value, DateTime|float|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)

Decrement the value of an item in the cache.

void
forever(string $key, mixed $value)

Store an item in the cache indefinitely.

mixed
remember(string $key, DateTime|float|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.

tags(array|mixed $names)

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

string
itemKey(string $key)

Format the key for a cache item.

float|int
getDefaultCacheTime()

Get the default cache time.

void
setDefaultCacheTime(float|int $minutes)

Set the default cache time in minutes.

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.

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

Calculate the number of minutes with the given duration.

void
__clone()

Clone cache repository instance.

Details

static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Handle dynamic calls into macros or pass missing methods to the store.

Parameters

string $method
array $parameters

Return Value

mixed

void __construct(Store $store)

Create a new cache repository instance.

Parameters

Store $store

Return Value

void

void setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance.

Parameters

Dispatcher $events

Return Value

void

protected void fireCacheEvent(string $event, array $payload)

Fire an event for this cache instance.

Parameters

string $event
array $payload

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

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

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

Retrieve an item from the cache and delete it.

Parameters

string $key
mixed $default

Return Value

mixed

void put(string $key, mixed $value, DateTime|float|int $minutes = null)

Store an item in the cache.

Parameters

string $key
mixed $value
DateTime|float|int $minutes

Return Value

void

void putMany(array $values, float|int $minutes)

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

Parameters

array $values
float|int $minutes

Return Value

void

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

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

Parameters

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

Decrement 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

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

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

Parameters

string $key
DateTime|float|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

bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

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

protected string itemKey(string $key)

Format the key for a cache item.

Parameters

string $key

Return Value

string

float|int getDefaultCacheTime()

Get the default cache time.

Return Value

float|int

void setDefaultCacheTime(float|int $minutes)

Set the default cache time in minutes.

Parameters

float|int $minutes

Return Value

void

Store getStore()

Get the cache store implementation.

Return Value

Store

bool offsetExists(string $key)

Determine if a cached value exists.

Parameters

string $key

Return Value

bool

mixed offsetGet(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

void offsetSet(string $key, mixed $value)

Store an item in the cache for the default time.

Parameters

string $key
mixed $value

Return Value

void

void offsetUnset(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

void

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

Calculate the number of minutes with the given duration.

Parameters

DateTime|float|int $duration

Return Value

float|int|null

void __clone()

Clone cache repository instance.

Return Value

void