freshcells/cache

PSR-6 cache implementation with keyGenerator & Compression

1.0.0 2018-12-21 13:52 UTC

Requires

• php: ^7.1
• psr/cache: ^1.0

Requires (Dev)

• cache/adapter-common: ^1.0
• cache/integration-tests: ^0.16
• phpunit/phpunit: ^5.7.21
• squizlabs/php_codesniffer: ^3.3
• symfony/cache: ^4.1

MIT

• Ivo Bathke

• cache
• psr6

README

PSR-6 Cache implementation with KeyGenerator and Compression.

KeyGeneration

This is an extension to PSR-6.
Cache data by a given var as key.
This can be an object, an array or any var.
Key-generation with SerializeKeyGenerator will serialize and md5 the given var, further you can add a custom prefix to it.

You can also define your own KeyGenerator according your needs by implementing the interfaces.

It is designed to cache data by a variable resp. query-object and the key will be generated based on this var. If you know the cache-key beforehand you can directly use the cache-pool instance instead.

$keyVar      = new \stdClass();
$keyVar->foo = ['baz' => 'bif'];
$item = $cache->getItemByVar($keyVar);
$item->set($data);
$cache->save($item);
$itemFromCache = $cache->getItemByVar($keyVar);

Compression

Data can be compressed and data will be serialized before its passed to the cache if possible.

$compression    = new GzCompression();
$cache = CompressionCachePool($innerCachePool, $compression);

Traits

Cache aware Traits for normal PSR-6 CacheItemPoolInterface and extended GeneratableKeyCache are provided.

CacheableTrait and GenerateableKeyCacheableTrait provide wrapper method to fetch and save cache data.

    ...
    use CachePoolAwareTrait;
    use CacheableTrait;

    public function load()
    {
        return $this->cacheable(
            self::CACHE_KEY,
            function () {
                $entity = new TestEntity();

                return $entity;
            },
            function ($data) {
                return $data instanceof TestEntity;
            }
        );
    }
    ...

Todo

Symfony Bridge Cache Bundle with CompilerPass for tag cacher.aware tag:

• name: 'cacher.aware', cache: cache.pool.service, enabled: %cache.enabled%

License

The MIT License (MIT). Please see License File for more information.