CacheBundle
:warning::warning::warning: CAUTION: THIS BUNDLE IS DEPRECATED AND THE DEVELOPMENT HAS MOVED TO A NEW REPOSITORY https://github.com/TheBigBrainsCompany/TbbcCacheBundle :warning::warning::warning:, (*1)
Add cache abstraction and method annotations for controlling cache.
The current implementation of the Cache component is a wrapper (proxy) for Doctrine\Common\Cache., (*2)
TODO
- ~~Add TTL strategy~~
- Add annotation handling for overridden classes
- Write more tests
- ~~Use cache name (from config) as namespace for cache keys~~
- Add cache configuration factories for all available cache drivers in Doctrine Cache
- ~~ArrayCache~~
- ~~ApcCache~~
- ~~MemcachedCache~~
- MemcacheCache
- FileCache
- RedisCache
-
[WIP] Add @CacheUpdate annotation for updating cache entry after method execution
- ~~Add options to @CacheEvict annotation for deleting all entries from cache.~~
- Add @CacheTTL annotation ??
-
[WIP] Add DataCollector for Cache operations
Index
State
Unstable. 
, (*3)
Installation
First, install the bundle package with composer:, (*4)
$ php composer.phar require kitano/cache-bundle
Next, activate the bundle (and bundle it depends on) into app/AppKernel.php:, (*5)
<?php
// ...
public function registerBundles()
{
$bundles = array(
//...
new Kitano\PelBundle\KitanoPelBundle(),
new Kitano\CacheBundle\KitanoCacheBundle(),
);
// ...
}
Configuration
services:
my_manager.product:
class: My\Manager\ProductManager
tags:
- { name: kitano_cache.cache_eligible }
kitano_cache:
annotations: { enabled: true }
manager: simple_cache
key_generator: simple_hash
metadata:
use_cache: true # Whether or not use metadata cache
cache_dir: %kernel.cache_dir%/kitano_cache
cache:
products:
type: memcached
servers:
memcached-01: { host: localhost, port: 11211 }
Note: The kitano_cache.cache_eligible tag is mandatory in your service definition if you want to be able to use
annotation for this service., (*6)
Usage
Basic Usage
CacheManager instance must be injected into services that need cache management., (*7)
The CacheManager gives access to each configured cache (see Configuration section).
Each cache implements CacheInterface., (*8)
Usage:, (*9)
<?php
namespace My\Manager;
use Kitano\CacheBundle\Annotation\Cacheable;
class ProductManager
{
private $cacheManager;
private $keyGenerator;
public function __construct(CacheManagerInterface $cacheManager, KeyGeneratorInterface $keyGenerator)
{
$this->cacheManager = $cacheManager;
$this->keyGenerator = $keyGenerator;
}
public function getProduct($sku, $type = 'book')
{
$cacheKey = $this->keyGenerator->generate($sku);
$cache = $this->cacheManager->getCache('products');
if ($product = $cache->get($cacheKey)) {
return $product;
}
$product = $this->productRepository->findProductBySkuAndType($sku, $type);
// ...
$cache->set($cacheKey, $product);
return $product;
}
public function saveProduct(Product $product)
{
// saving product ...
$cacheKey = $this->keyGenerator->generate($product->getSku());
$this->cacheManager->getCache('products')->delete($cacheKey);
}
}
Custom Cache Manager
Out of the box, the bundle provides a
SimpleCacheManager, but
custom cache managers can be used instead of the default one and must implement the
CacheManagerInterface., (*10)
Key generation
Key generation is up to the developer, but for convenience, the bundle comes with some key generation logic., (*11)
Note: When using Annotation based caching, usage of Key generators is mandatory., (*12)
Out of the box, the bundle provides a
SimpleHashKeyGenerator
which basically adds each param encoded using md5 algorithm, and returned a md5 hash of the result., (*13)
For testing purpose you may also use
LiteralKeyGenerator
which build a slug-like key., (*14)
Note: Both generators does not support non-scalar keys such as objects., (*15)
You can override the Key Generator by setting the key_generator key in your config.yml, (*16)
Allowed values are: simple_hash, literal or the id of the service of your custom Key generator, (*17)
Custom Key generation
Custom key generators can be used instead of the default one and must implement the
KeyGeneratorInterface., (*18)
Annotation based caching
Recommended, (*19)
If some prefer to avoid repeating code each time they want to add some caching logic, the bundle can automate the process
by using AOP approach and annotations., (*20)
The bundle provides the following annotations:
* @Cacheable
* @CacheEvict
* @CacheUpdate, (*21)
@Cacheable annotation
@Cacheable annotation is used to automatically store the result of a method into the cache., (*22)
When a method demarcated with the @Cacheable annotation is called, the bundle checks if an entry exists in the cache
before executing the method. If it finds one, the cache result is returned without having to actually execute the method., (*23)
If no cache entry is found, the method is executed and the bundle automatically stores its result into the cache., (*24)
<?php
namespace My\Manager;
use My\Model\Product;
use Kitano\CacheBundle\Annotation\Cacheable;
class ProductManager
{
/**
* @Cacheable(caches="products", key="#sku")
*/
public function getProduct($sku, $type = 'book')
{
$product = new Product($sku, $type);
return $product;
}
}
@CacheEvict annotation
@CacheEvict annotation allows methods to trigger cache population or cache eviction., (*25)
When a method is demarcated with @CacheEvict annotation, the bundle will execute the method and then will automatically
try to delete the cache entry with the provided key., (*26)
<?php
namespace My\Manager;
use My\Model\Product;
use Kitano\CacheBundle\Annotation\CacheEvict;
class ProductManager
{
/**
* @CacheEvict(caches="products", key="#product.getSku()")
*/
public function saveProduct(Product $product)
{
// saving product ...
}
}
It is also possible to flush completely the caches by setting allEntries parameter to true, (*27)
<?php
namespace My\Manager;
use My\Model\Product;
use Kitano\CacheBundle\Annotation\CacheEvict;
class ProductManager
{
/**
* @CacheEvict(caches="products", allEntries=true)
*/
public function saveProduct(Product $product)
{
// saving product ...
}
}
Note: If you also provide a key, it will be ignored and the cache will be flushed., (*28)
@CacheUpdate annotation
@CacheUpdate annotation is useful for cases where the cache needs to be updated without interfering with the method
execution., (*29)
When a method is demarcated with @CacheUpdate annotation, the bundle will always execute the method and then will
automatically try to update the cache entry with the method result., (*30)
<?php
namespace My\Manager;
use My\Model\Product;
use Kitano\CacheBundle\Annotation\CacheUpdate;
class ProductManager
{
/**
* @CacheUpdate(caches="products", key="#product.getSku()")
*/
public function saveProduct(Product $product)
{
// saving product....
return $product;
}
}
Expression Language
For key generation, PHP Expression Language can be used., (*31)
TODO: write some doc here, (*32)
TTL Strategy
Since this bundle provides a cache abstraction and not all cache providers support or handle TTL the same way,
TTL strategy must be defined in each cache configuration options (when option is supported)., (*33)
Example:, (*34)
kitano_cache:
annotations: { enabled: true }
manager: simple_cache
cache:
products:
type: memcached
ttl: 86400 # 1 day
servers:
memcached-01: { host: localhost, port: 11211 }
user_feeds:
type: memcached
ttl: 0 # infinite (same as omitting the option)
followers_list:
type: apc
ttl: 1296000 # 15 days
Testing
Install development dependencies, (*35)
$ composer install --dev
Run the test suite, (*36)
$ vendor/bin/phpunit
License
This bundle is under the MIT license. See the complete license in the bundle:, (*37)
Resources/meta/LICENSE
Wallogit.com
