Repository

class Repository implements ArrayAccess (View source)

Traits

MacroableTrait

Properties

static protected array $macros The registered string macros. from MacroableTrait
protected StoreInterface $store The cache store implementation.
protected int $default The default number of minutes to store items.

Methods

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

Register a custom macro.

 from MacroableTrait
static boolean hasMacro(string $name)

Checks if macro is registered

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

Dynamically handle calls to the class.

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

Handle dynamic calls into macros or pass missing methods to the store.
__construct(StoreInterface $store)

Create a new cache repository 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.
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)

Store an item in the cache.
bool add(string $key, mixed $value, DateTime|int $minutes)

Store an item in the cache if the key does not exist.
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.
int getDefaultCacheTime()

Get the default cache time.
void setDefaultCacheTime(int $minutes)

Set the default cache time in minutes.
StoreInterface 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.
int|null getMinutes(DateTime|int $duration)

Calculate the number of minutes with the given duration.

Details

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

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

static boolean hasMacro(string $name)

Checks if macro is registered

Parameters

string $name

Return Value

boolean

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

__construct(StoreInterface $store)

Create a new cache repository instance.

Parameters

StoreInterface $store

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

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|int $minutes)

Store an item in the cache.

Parameters

string $key
mixed $value
DateTime|int $minutes

Return Value

void

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

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

Parameters

string $key
mixed $value
DateTime|int $minutes

Return Value

bool

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

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

Parameters

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

int getDefaultCacheTime()

Get the default cache time.

Return Value

int

void setDefaultCacheTime(int $minutes)

Set the default cache time in minutes.

Parameters

int $minutes

Return Value

void

StoreInterface getStore()

Get the cache store implementation.

Return Value

StoreInterface

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 int|null getMinutes(DateTime|int $duration)

Calculate the number of minutes with the given duration.

Parameters

DateTime|int $duration

Return Value

int|null

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Cache/Repository.html