becklyn/cache

A cache bundle providing a simple (and fast) cache

1.1.0 2022-02-17 14:22 UTC

Requires

• php: >=7.4
• ext-json: *
• symfony/cache: ^5.4.3 || ^6.0.3
• symfony/config: ^5.4.3 || ^6.0.3
• symfony/dependency-injection: ^5.4.3 || ^6.0.3
• symfony/filesystem: ^5.4.3 || ^6.0.3
• symfony/framework-bundle: ^5.4.3 || ^6.0.3
• symfony/http-kernel: ^5.4.4 || ^6.0.4

Requires (Dev)

• roave/security-advisories: dev-master
• symfony/phpunit-bridge: ^5.4.3 || ^6.0.3

BSD-3-Clause

• Becklyn Studios

README

Provides a simple cache, that should be easy to use and high performance. Warning: for highly concurrent usage you should either prepare the cache in advance or use symfony's own cache, as it has proper cache stampede protection.

Usage

Fetch the simple cache factory and get the cache item:

use Becklyn\Cache\Cache\SimpleCacheFactory;

class MyService
{
    private SimpleCacheItemInterface $cache;

    /**
     */
    public function __construct (SimpleCacheFactory $cacheFactory)
    {
        $this->cache = $cacheFactory->getItem(
            "my.cache.key",
            fn () => $this->loadItems()
        );
    }


    /**
     * Returns the cached or fresh items, depending on several conditions. 
     */
    public function getItems () : array
    {
        return $this->cache->get();
    }
    

    /**
     * Loads the items from the database
     */
    public function loadItems () : array
    {
        // ...
    }
}

Caching Based on Symfony Config

You can either pass the cache key and generator to the getItem() method (like in the example above), or you can additionally pass in resources that should be tracked and can be used for cache invalidation.

If you pass resources, this will be a two-level cache:

1. first level will be the plain symfony/cache, which is really fast but has no proper way of cache invalidation.
2. second level will be the ConfigCache which will automatically be invalidated if some of the tracked resources change.

$cacheFactory->getItem(
    "my.cache.key",
    fn () => $this->loadItems(),
    // eg. if your cache status depends on routing resources
    $this->router->getRouteCollection()->getResources()
 );