W3cubDocs

/Laravel 8

CacheManager

class CacheManager implements Factory (View source)

Properties

protected Application $app The application instance.
protected array $stores The array of resolved cache stores.
protected array $customCreators The registered custom driver creators.

Methods

void __construct(Application $app)

Create a new Cache manager instance.
Repository store(string|null $name = null)

Get a cache store instance by name, wrapped in a repository.
Repository driver(string|null $driver = null)

Get a cache driver instance.
Repository get(string $name)

Attempt to get the store from the local cache.
Repository resolve(string $name)

Resolve the given store.
mixed callCustomCreator(array $config)

Call a custom driver creator.
Repository createApcDriver(array $config)

Create an instance of the APC cache driver.
Repository createArrayDriver(array $config)

Create an instance of the array cache driver.
Repository createFileDriver(array $config)

Create an instance of the file cache driver.
Repository createMemcachedDriver(array $config)

Create an instance of the Memcached cache driver.
Repository createNullDriver()

Create an instance of the Null cache driver.
Repository createRedisDriver(array $config)

Create an instance of the Redis cache driver.
Repository createDatabaseDriver(array $config)

Create an instance of the database cache driver.
Repository createDynamodbDriver(array $config)

Create an instance of the DynamoDB cache driver.
Repository repository(Store $store)

Create a new cache repository with the given implementation.
void setEventDispatcher(Repository $repository)

Set the event dispatcher on the given repository instance.
void refreshEventDispatcher()

Re-set the event dispatcher on all resolved cache repositories.
string getPrefix(array $config)

Get the cache prefix.
array getConfig(string $name)

Get the cache connection configuration.
string getDefaultDriver()

Get the default cache driver name.
void setDefaultDriver(string $name)

Set the default cache driver name.
$this forgetDriver(array|string|null $name = null)

Unset the given driver instances.
void purge(string|null $name = null)

Disconnect the given driver and remove from local cache.
$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Details

void __construct(Application $app)

Create a new Cache manager instance.

Parameters

Application $app

Return Value

void

Repository store(string|null $name = null)

Get a cache store instance by name, wrapped in a repository.

Parameters

string|null $name

Return Value

Repository

Repository driver(string|null $driver = null)

Get a cache driver instance.

Parameters

string|null $driver

Return Value

Repository

protected Repository get(string $name)

Attempt to get the store from the local cache.

Parameters

string $name

Return Value

Repository

protected Repository resolve(string $name)

Resolve the given store.

Parameters

string $name

Return Value

Repository

Exceptions

InvalidArgumentException

protected mixed callCustomCreator(array $config)

Call a custom driver creator.

Parameters

array $config

Return Value

mixed

protected Repository createApcDriver(array $config)

Create an instance of the APC cache driver.

Parameters

array $config

Return Value

Repository

protected Repository createArrayDriver(array $config)

Create an instance of the array cache driver.

Parameters

array $config

Return Value

Repository

protected Repository createFileDriver(array $config)

Create an instance of the file cache driver.

Parameters

array $config

Return Value

Repository

protected Repository createMemcachedDriver(array $config)

Create an instance of the Memcached cache driver.

Parameters

array $config

Return Value

Repository

protected Repository createNullDriver()

Create an instance of the Null cache driver.

Return Value

Repository

protected Repository createRedisDriver(array $config)

Create an instance of the Redis cache driver.

Parameters

array $config

Return Value

Repository

protected Repository createDatabaseDriver(array $config)

Create an instance of the database cache driver.

Parameters

array $config

Return Value

Repository

protected Repository createDynamodbDriver(array $config)

Create an instance of the DynamoDB cache driver.

Parameters

array $config

Return Value

Repository

Repository repository(Store $store)

Create a new cache repository with the given implementation.

Parameters

Store $store

Return Value

Repository

protected void setEventDispatcher(Repository $repository)

Set the event dispatcher on the given repository instance.

Parameters

Repository $repository

Return Value

void

void refreshEventDispatcher()

Re-set the event dispatcher on all resolved cache repositories.

Return Value

void

protected string getPrefix(array $config)

Get the cache prefix.

Parameters

array $config

Return Value

string

protected array getConfig(string $name)

Get the cache connection configuration.

Parameters

string $name

Return Value

array

string getDefaultDriver()

Get the default cache driver name.

Return Value

string

void setDefaultDriver(string $name)

Set the default cache driver name.

Parameters

string $name

Return Value

void

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

Unset the given driver instances.

Parameters

array|string|null $name

Return Value

$this

void purge(string|null $name = null)

Disconnect the given driver and remove from local cache.

Parameters

string|null $name

Return Value

void

$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

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