BerylliumCacheBundle for Symfony2

It's memcache. You've seen it before. Now it's injectable to the DIC, and you don't have to write all this junk yourself. And it should also work with Amazon ElasticCache, as well as the MySQL Memcache Interface (new in MySQL 5.6).

Another advantage over just using a raw memcache object is that BCB probes servers before adding them to the pool - if a server is down, your site won't be gravely impacted by the Memcache class waiting and waiting and waiting for a response.

The groundwork is also laid out for building alternate cache interfaces quickly - such as APC caching, or your own home-rolled filesystem cache.

Configuration

Step 1: Fetching

If you are using composer, you probably only need to add this to your composer.json file:

"require": {
  "beryllium/cache-bundle": "dev-master"
},

If you aren't using composer, add this to your deps file:

[BerylliumCacheBundle]
    git=http://github.com/beryllium/CacheBundle.git
    target=/bundles/Beryllium/CacheBundle

And then run the update vendors script:

bin/vendors install

Step 2: Configure autoload.php

If you aren't using Composer, register the namespace like so:

# app/autoload.php

<?php

$loader->registerNamespaces( array(
  //...
  'Beryllium' => __DIR__.'/../vendor/bundles',
  ) );

Step 3: Configure the AppKernel

Add it to your AppKernel:

# app/AppKernel.php

<?php

    $bundles = array(
        //...
        new Beryllium\CacheBundle\BeCacheBundle(),
    );

Default configuration

be_cache:
    client:         filecache
    ttl:            300
    parameters:
        memcache:
            ip:     127.0.0.1
            port:   11211
        filecache:
            path:   "%kernel.cache_dir%/apc"
    debug:          %kernel.debug%

If you plan on using local UNIX sockets, @gierschv has contributed the ability to do this:

be_cache:
    client:     memcache
    parameters:
        memcache:
            ip:     "unix:///tmp/mc.sock"
            port:   ""

Usage

After all this steps you should be good to go:

$this->get('be_cache')->set('key', 'value', $ttl);
$this->get('be_cache')->get('key');

Available backends

* APC
* Memcache
* File system

The Command Line

For a command line report of CacheClient statistics (assuming the cache client implements StatsInterface), you can do the following:

app/console cacheclient:stats

Example Output:

Instance: APC
 -------------- ------- 
  Hits:          26      
  Misses:        29      
  Helpfulness:   47.27%  
  Uptime: 344976 seconds
  Open connections: 10
 -------------- ------- 

Help is available, although brief:

app/console help cacheclient:stats

The Future

Currently there aren't any unit or functional tests. So that needs to be worked on.

More cache client implementations could be useful, if it turns out there's a demand for them.

And yes, the documentation needs to be more thorough as well. I've made some improvements, but it's still spotty at best.

Beyond that, who knows what the future might hold.

Additional Resources

MySQL InnoDB+Memcached API:

• http://blogs.innodb.com/wp/2011/04/get-started-with-innodb-memcached-daemon-plugin/

Amazon ElastiCache:

• http://aws.amazon.com/elasticache/