aequasi/cache-bundle

Creates services in Symfony 2, for cache, that can also be used with doctrines three cache types (metadata, result, and query). It also provides functionality for session handler support, and Router support.

Installs: 34 815

Dependents: 0

Stars: 29

Watches: 5

Forks: 10

Open Issues: 5

Language: PHP

3.0.1 2015-06-22 10:22 UTC

README

Cache Bundle for Symfony 2

Creates services in Symfony 2, for cache, that can also be used with doctrines three cache types (metadata, result, and query). It also provides functionality for session handler support, and Router support.

Should work in all versions of Symfony, and php 5.3

The respective cache extensions will be required for your project.

Redis uses the php redis extension.

Requirements To Install

Run the following in your project root, assuming you have composer set up for your project

composer.phar require aequasi/cache-bundle ~2.4.0

Switching ~2.4.0 for the most recent tag.

Add the bundle to app/AppKernel.php

$bundles(
    ...
       new Aequasi\Bundle\CacheBundle\AequasiCacheBundle(),
    ...
);

Then add parameters (probably in config.yml) for your servers, and options

aequasi_cache:
    instances:
        default:
          persistent: true # Boolean or persistent_id
          namespace: mc
          type: memcached
          hosts:
              - { host: localhost, port: 11211 }

To see all the config options, run php app/console config:dump-reference aequasi_cache to view the config settings

Doctrine

This bundle allows you to use its services for Doctrine's caching methods of metadata, result, and query.

If you want doctrine to use this as the result and query cache, add this

aequasi_cache:
    doctrine:
        enabled: true
        metadata:
            instance: default
            entity_managers:   [ default ]          # the name of your entity_manager connection
            document_managers: [ default ]       # the name of your document_manager connection
        result:
            instance: default
            entity_managers:   [ default, read ]  # you may specify multiple entity_managers
        query:
            instance: default
            entity_managers: [ default ]
Session

This bundle even allows you to store your session data in one of your cache clusters. To enable:

aequasi_cache:
    session:
        enabled: true
        instance: default
        prefix: "session_"
        ttl: 7200
Router

This bundle also provides router caching, to help speed that section up. To enable:

aequasi_cache:
    router:
        enabled: true
        instance: default

If you change any of your routes, you will need to clear all of the route_* keys in your cache.

To Use

To use this with doctrine's entity manager, just make sure you have useResultCache and/or useQueryCache set to true. If you want to use the user cache, just grab the service out of the container like so:

// Change default to the name of your instance
$cache = $container->get( 'aequasi_cache.instance.default' );
// Or
$cache = $container->get( 'aequasi_cache.default' );

Here is an example usage of the service:

$cache = $this->get( 'aequasi_cache.instance.default' );
$key = 'test';
if( $data = $cache->fetch( $key ) ) {
    print_r( $data );
} else {
    /** @var $em \Doctrine\ORM\EntityManager */
    $data = $em->find( 'AcmeDemoBundle:User', 1 );
    $cache->save( $key, $data, 3600 );
}

There is also the cache() function on the service that allows you to wrap the above, into a single function:

$cache = $this->get( 'aequasi_cache.instance.default' );
$user = $cache->cache( 'test', function() use( $em ) { return $em->find( "AcmeDemoBundle:User", 1 ); }, 3600 );
var_dump( $user );

Need Help?

Create an issue if you've found a bug,

or email me at aequasi@gmail.com

Bitdeli Badge