epwt/cache-bundle

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
This package is abandoned and no longer maintained. No replacement package was suggested.

EPWT/Cache Symfony Bundle PSR-6 Cache Item Pool

1.0.0 2015-04-27 22:54 UTC

This package is auto-updated.

Last update: 2021-01-17 09:20:32 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License Analytics

SensioLabsInsight

The EPWTCacheBundle provides wrapper for epwt/cache library smashed with Symfony DependencyInjection magic.

EPWT/Cache

EPWT/Cache is PSR-6 (Yes it only proposed) compiliant CacheItemPool implementation for Redis and maybe in future other Cache storage.

Require

Instalation

composer require epwt/cache-bundle "~1.0"
public function registerBundles()
{
	$bundles[] = new EPWT\CacheBundle\EPWTCacheBundle();
}

Configuration

All CacheItemPool configuration is done via Symfony Container

Currently supported drivers:

  • redis
  • sncredis

Configuration Examples

Redis Driver

<service id="acme.demo.items.pool" class="stdClass">
    <tag name="epwt_cache_pool" alias="acme_demo_pool" driver="redis" redis-id="acme.demo.redis"/>
</service>

SncRedis Driver

<service id="acme.demo.items.pool" class="stdClass">
    <tag name="epwt_cache_pool" alias="acme_demo_pool" driver="snc_redis" sncredis-client="default"/>
</service>

Additional Options

  • If you want you can extend CacheItemPool class and specify it in class attribute.
  • By default CacheItemPool name is alias attribute value but if you want use different one specify with pool-name attribute
  • If you want to specify whole CacheItemPool default TTL use attribute default-ttl value is in seconds from setting value

Usage Examples

  • This bundle has CacheItemPoolsContainer service with id epwt_cache_pools
  • This budnle also provides CacheItemPoolsAwareTrait with requires $this->getContainer method, $this->container property or $this->get() method (In Controllers only) and provides getCacheItemPool($name) method for getting CacheItemPool

With Trait

class HelloWorldCommand extends ContainerAwareCommand
{
    use CacheItemPoolsAwareTrait;

    protected function configure()
    {
        $this->setName('acme:hello');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $pool = $this->getCacheItemPool('acme_demo_pool');

        $poolItem = new CacheItem('foo');
        $poolItem->set('bar');

        $pool->save($poolItem);
    }
}

Without Trait

class HelloWorldCommand extends ContainerAwareCommand
{
    protected function configure()
    {
        $this->setName('acme:hello');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $pool = $this->getContainer()->get('epwt_cache_pools')->get('acme_demo_pool');

        $poolItem = new CacheItem('foo');
        $poolItem->set('bar');

        $pool->save($poolItem);
    }
}

License

This bundle is under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE

About

EPWTCacheBundle is brought to you by Aurimas Niekis.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.

When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps.