1. class
  2. Illuminate
  3. Cache
  4. Repository

Repository

class Repository implements Repository, ArrayAccess (View source)

Traits

Macroable

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.

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|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.

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.

void
__clone()

Clone cache repository instance.

Details

in Macroable at line line 24
static void macro( string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line line 35
static bool hasMacro( string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line line 49
static mixed __callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 481
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

at line line 48
void __construct( Store $store)

Create a new cache repository instance.

Parameters

Store $store

Return Value

void

at line line 59
void setEventDispatcher( Dispatcher $events)

Set the event dispatcher instance.

Parameters

Dispatcher $events

Return Value

void

at line line 111
bool has( string $key)

Determine if an item exists in the cache.

Parameters

string $key

Return Value

bool

at line line 123
mixed get( string $key, mixed $default = null)

Retrieve an item from the cache by key.

Parameters

string $key
mixed $default

Return Value

mixed

at line line 150
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

at line line 180
mixed pull( string $key, mixed $default = null)

Retrieve an item from the cache and delete it.

Parameters

string $key
mixed $default

Return Value

mixed

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

Store an item in the cache.

Parameters

string $key
mixed $value
DateTime|int $minutes

Return Value

void

at line line 219
void putMany( array $values, int $minutes)

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

Parameters

array $values
int $minutes

Return Value

void

at line line 240
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

at line line 268
void forever( string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

void

at line line 283
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

at line line 304
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

at line line 316
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

at line line 336
bool forget( string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line line 353
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

at line line 386
int getDefaultCacheTime()

Get the default cache time.

Return Value

int

at line line 397
void setDefaultCacheTime( int $minutes)

Set the default cache time in minutes.

Parameters

int $minutes

Return Value

void

at line line 407
Store getStore()

Get the cache store implementation.

Return Value

Store

at line line 418
bool offsetExists( string $key)

Determine if a cached value exists.

Parameters

string $key

Return Value

bool

at line line 429
mixed offsetGet( string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

at line line 441
void offsetSet( string $key, mixed $value)

Store an item in the cache for the default time.

Parameters

string $key
mixed $value

Return Value

void

at line line 452
void offsetUnset( string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

void

at line line 495
void __clone()

Clone cache repository instance.

Return Value

void