Cache

class Cache extends Facade mixin Repository (View source)

Properties

static protected Application	$app	The application instance being facaded.	from Facade
static protected array	$resolvedInstance	The resolved object instances.	from Facade
static protected bool	$cached	Indicates if the resolved instance should be cached.	from Facade

Methods

static void

resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from Facade

static MockInterface

spy()

Convert the facade into a Mockery spy.

from Facade

static MockInterface

partialMock()

Initiate a partial mock on the facade.

from Facade

static Expectation

shouldReceive()

Initiate a mock expectation on the facade.

from Facade

static Expectation

expects()

Initiate a mock expectation on the facade.

from Facade

static MockInterface

createFreshMockInstance()

Create a fresh mock instance for the given class.

from Facade

static MockInterface

createMock()

Create a fresh mock instance for the given class.

from Facade

static bool

isMock()

Determines whether a mock is set as the instance of the facade.

from Facade

static string|null

getMockableClass()

Get the mockable class for the bound instance.

from Facade

static void

swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from Facade

static bool

isFake()

Determines whether a "fake" has been set as the facade instance.

from Facade

static mixed

getFacadeRoot()

Get the root object behind the facade.

from Facade

static string

getFacadeAccessor()

Get the registered name of the component.

static mixed

resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from Facade

static void

clearResolvedInstance(string $name)

Clear a resolved facade instance.

from Facade

static void

clearResolvedInstances()

Clear all of the resolved instances.

from Facade

static Collection

defaultAliases()

Get the application default aliases.

from Facade

static Application

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static Repository

store(string|null $name = null)

No description

static Repository

driver(string|null $driver = null)

No description

static Repository

resolve(string $name)

No description

static Repository

repository(Store $store)

No description

static void

refreshEventDispatcher()

No description

static string

getDefaultDriver()

No description

static void

setDefaultDriver(string $name)

No description

static CacheManager

forgetDriver(array|string|null $name = null)

No description

static void

purge(string|null $name = null)

No description

static CacheManager

extend(string $driver, Closure $callback)

No description

static CacheManager

setApplication(Application $app)

No description

static bool

has(array|string $key)

No description

static bool

missing(string $key)

No description

static mixed

get(array|string $key, Closure $default = null)

No description

static array

many(array $keys)

No description

static iterable

getMultiple(iterable $keys, mixed $default = null)

No description

static mixed

pull(array|string $key, Closure $default = null)

No description

static bool

put(array|string $key, mixed $value, DateInterval|int|null $ttl = null)

No description

static bool

set(string $key, mixed $value, DateInterval $ttl = null)

No description

static bool

putMany(array $values, DateInterval|int|null $ttl = null)

No description

static bool

setMultiple(iterable $values, DateInterval $ttl = null)

No description

static bool

add(string $key, mixed $value, DateInterval|int|null $ttl = null)

No description

static int|bool

increment(string $key, mixed $value = 1)

No description

static int|bool

decrement(string $key, mixed $value = 1)

No description

static bool

forever(string $key, mixed $value)

No description

static mixed

remember(string $key, DateInterval|int|null $ttl, Closure $callback)

No description

static mixed

sear(string $key, Closure $callback)

No description

static mixed

rememberForever(string $key, Closure $callback)

No description

static bool

forget(string $key)

No description

static bool

delete(string $key)

No description

static bool

deleteMultiple(iterable $keys)

No description

static bool

clear()

No description

static TaggedCache

tags(array|mixed $names)

No description

static bool

supportsTags()

No description

static int|null

getDefaultCacheTime()

No description

static Repository

setDefaultCacheTime(int|null $seconds)

No description

static Store

getStore()

No description

static Repository

setStore(Store $store)

No description

static Dispatcher

getEventDispatcher()

No description

static void

setEventDispatcher(Dispatcher $events)

No description

static void

macro(string $name, object|callable $macro)

No description

static void

mixin(object $mixin, bool $replace = true)

No description

static bool

hasMacro(string $name)

No description

static void

flushMacros()

No description

static mixed

macroCall(string $method, array $parameters)

No description

static bool

flush()

No description

static string

getPrefix()

No description

static Lock

lock(string $name, int $seconds, string|null $owner = null)

No description

static Lock

restoreLock(string $name, string $owner)

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure

$callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed

$instance

Return Value

void

static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string

$name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string

$name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string	$method
array	$args

Return Value

mixed

Exceptions

RuntimeException

static Repository store(string|null $name = null)

No description

Parameters

string|null

$name

Return Value

Repository

static Repository driver(string|null $driver = null)

No description

Parameters

string|null

$driver

Return Value

Repository

static Repository resolve(string $name)

No description

Parameters

string

$name

Return Value

Repository

static Repository repository(Store $store)

No description

Parameters

Store

$store

Return Value

Repository

static void refreshEventDispatcher()

No description

Return Value

void

static string getDefaultDriver()

No description

Return Value

string

static void setDefaultDriver(string $name)

No description

Parameters

string

$name

Return Value

void

static CacheManager forgetDriver(array|string|null $name = null)

No description

Parameters

array|string|null

$name

Return Value

CacheManager

static void purge(string|null $name = null)

No description

Parameters

string|null

$name

Return Value

void

static CacheManager extend(string $driver, Closure $callback)

No description

Parameters

string	$driver
Closure	$callback

Return Value

CacheManager

static CacheManager setApplication(Application $app)

No description

Parameters

Application

$app

Return Value

CacheManager

static bool has(array|string $key)

No description

Parameters

array|string

$key

Return Value

bool

static bool missing(string $key)

No description

Parameters

string

$key

Return Value

bool

static mixed get(array|string $key, Closure $default = null)

No description

Parameters

array\|string	$key
Closure	$default

Return Value

mixed

static array many(array $keys)

No description

Parameters

array

$keys

Return Value

array

static iterable getMultiple(iterable $keys, mixed $default = null)

No description

Parameters

iterable	$keys
mixed	$default

Return Value

iterable

static mixed pull(array|string $key, Closure $default = null)

No description

Parameters

array\|string	$key
Closure	$default

Return Value

mixed

static bool put(array|string $key, mixed $value, DateInterval|int|null $ttl = null)

No description

Parameters

array\|string	$key
mixed	$value
DateInterval\|int\|null	$ttl

Return Value

bool

static bool set(string $key, mixed $value, DateInterval $ttl = null)

No description

Parameters

string	$key
mixed	$value
DateInterval	$ttl

Return Value

bool

static bool putMany(array $values, DateInterval|int|null $ttl = null)

No description

Parameters

array	$values
DateInterval\|int\|null	$ttl

Return Value

bool

static bool setMultiple(iterable $values, DateInterval $ttl = null)

No description

Parameters

iterable	$values
DateInterval	$ttl

Return Value

bool

static bool add(string $key, mixed $value, DateInterval|int|null $ttl = null)

No description

Parameters

string	$key
mixed	$value
DateInterval\|int\|null	$ttl

Return Value

bool

static int|bool increment(string $key, mixed $value = 1)

No description

Parameters

string	$key
mixed	$value

Return Value

int|bool

static int|bool decrement(string $key, mixed $value = 1)

No description

Parameters

string	$key
mixed	$value

Return Value

int|bool

static bool forever(string $key, mixed $value)

No description

Parameters

string	$key
mixed	$value

Return Value

bool

static mixed remember(string $key, DateInterval|int|null $ttl, Closure $callback)

No description

Parameters

string	$key
DateInterval\|int\|null	$ttl
Closure	$callback

Return Value

mixed

static mixed sear(string $key, Closure $callback)

No description

Parameters

string	$key
Closure	$callback

Return Value

mixed

static mixed rememberForever(string $key, Closure $callback)

No description

Parameters

string	$key
Closure	$callback

Return Value

mixed

static bool forget(string $key)

No description

Parameters

string

$key

Return Value

bool

static bool delete(string $key)

No description

Parameters

string

$key

Return Value

bool

static bool deleteMultiple(iterable $keys)

No description

Parameters

iterable

$keys

Return Value

bool

static bool clear()

No description

Return Value

bool

static TaggedCache tags(array|mixed $names)

No description

Parameters

array|mixed

$names

Return Value

TaggedCache

static bool supportsTags()

No description

Return Value

bool

static int|null getDefaultCacheTime()

No description

Return Value

int|null

static Repository setDefaultCacheTime(int|null $seconds)

No description

Parameters

int|null

$seconds

Return Value

Repository

static Store getStore()

No description

Return Value

Store

static Repository setStore(Store $store)

No description

Parameters

Store

$store

Return Value

Repository

static Dispatcher getEventDispatcher()

No description

Return Value

Dispatcher

static void setEventDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher

$events

Return Value

void

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

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

No description

Parameters

string	$method
array	$parameters

Return Value

mixed

static bool flush()

No description

Return Value

bool

static string getPrefix()

No description

Return Value

string

static Lock lock(string $name, int $seconds, string|null $owner = null)

No description

Parameters

string	$name
int	$seconds
string\|null	$owner

Return Value

Lock

static Lock restoreLock(string $name, string $owner)

No description

Parameters

string	$name
string	$owner

Return Value

Lock

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Cache.html