README

A simple PSR-6/PSR-16 compatible disk cache for PHP

Installation

The recommended method of installing this library is via Composer.

Run the following command from your project root:

$ composer require duncan3dc/cache

Quick Examples

There are 2 cache providers available, one is the local filesystem and the other is simple array cache in memory.

Using the FilesystemPool will persist data forever (or until the filesystem is purged).

$cache = new \duncan3dc\Cache\FilesystemPool(sys_get_temp_dir());

# The $cache object implements PSR-6
$userData = $cache->getItem("user_data")->get();

# ...and PSR-16
$userData = $cache->get("user_data");

Using the ArrayPool will not persist data beyond the current request.

$cache = new \duncan3dc\Cache\ArrayPool();

# The $cache object implements PSR-6
$userData = $cache->getItem("user_data")->get();

# ...and PSR-16
$userData = $cache->get("user_data");

There's also a trait to allow any method to be automatically cached.

$cache = new class {
    use \duncan3dc\Cache\CacheCallsTrait;

    public function _getData()
    {
        return [];
    }
};

$cache->getData();

The first time getData() is called then _getData() will be run, but after that future calls to getData() will just return the cached result from the first call to _getData().

Changelog

A Changelog has been available since the beginning of time

Where to get help

Found a bug? Got a question? Just not sure how something works?
Please create an issue and I'll do my best to help out.
Alternatively you can catch me on Twitter

duncan3dc/cache for enterprise

Available as part of the Tidelift Subscription

The maintainers of duncan3dc/cache and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.