class RedisTaggedCache extends TaggedCache (View source)

Traits

Constants

REFERENCE_KEY_FOREVER

Forever reference key.

REFERENCE_KEY_STANDARD

Standard reference key.

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.

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 = null)

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.

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.

section( string $name)

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

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.

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.

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

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

in Macroable at line line 71
mixed __call( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in TaggedCache at line line 23
void __construct( Store $store, TagSet $tags)

Create a new tagged cache instance.

Parameters

Store $store
TagSet $tags

Return Value

void

in Repository at line line 59
void setEventDispatcher( Dispatcher $events)

Set the event dispatcher instance.

Parameters

Dispatcher $events

Return Value

void

in Repository at line line 84
bool has( string $key)

Determine if an item exists in the cache.

Parameters

string $key

Return Value

bool

in Repository at line line 96
mixed get( string $key, mixed $default = null)

Retrieve an item from the cache by key.

Parameters

string $key
mixed $default

Return Value

mixed

in Repository at line line 118
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 28
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

in Repository at line line 154
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 42
void forever( string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

void

in Repository at line line 197
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

in Repository at line line 218
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

in Repository at line line 230
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

in Repository at line line 250
bool forget( string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

in Repository at line line 267
TaggedCache section( string $name)

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

Parameters

string $name

Return Value

TaggedCache

in Repository at line line 280
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

in Repository at line line 313
int getDefaultCacheTime()

Get the default cache time.

Return Value

int

in Repository at line line 324
void setDefaultCacheTime( int $minutes)

Set the default cache time in minutes.

Parameters

int $minutes

Return Value

void

in Repository at line line 334
Store getStore()

Get the cache store implementation.

Return Value

Store

in Repository at line line 345
bool offsetExists( string $key)

Determine if a cached value exists.

Parameters

string $key

Return Value

bool

in Repository at line line 356
mixed offsetGet( string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

in Repository at line line 368
void offsetSet( string $key, mixed $value)

Store an item in the cache for the default time.

Parameters

string $key
mixed $value

Return Value

void

in Repository at line line 379
void offsetUnset( string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

void

in Repository at line line 422
void __clone()

Clone cache repository instance.

Return Value

void

in TaggedCache at line line 47
void increment( string $key, mixed $value = 1)

Increment the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

void

in TaggedCache at line line 59
void decrement( string $key, mixed $value = 1)

Increment the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

void

at line line 54
void flush()

Remove all items from the cache.

Return Value

void

in TaggedCache at line line 88
string taggedItemKey( string $key)

Get a fully qualified key for a tagged item.

Parameters

string $key

Return Value

string