README.md

TagcacheBundle

Introduction

This bundle provides cache with tags.

Features

• Stores a cache with multiple tags. And deletes cache by using tag.
• Provides controller cache.

Requirements

• Annotations for Controllers.

Installation

editing the composer.json file in the root project.

Editing the composer.json under require: {} section add

"rickysu/tagcache-bundle": "1.0.*",

Update Bundle :

php composer.phar update

Instantiate Bundle :

<?php
//app/AppKernel.hpp
public function registerBundles()
{
   $bundles = array(
        // ...
        new RickySu\TagcacheBundle\TagcacheBundle(),
   );
}

Configuration

Configure cache adapter

# app/config/config.yml
tagcache:
    driver:                     Memcache
    debug:                      %kernel.debug%
    options:
        hashkey:                true
        enable_largeobject:     false
        cache_dir:              "%kernel.cache_dir%/tagcache"
        servers:
            -    'localhost:11211:10'
            -    'otherhost:11211:20'

# app/config/config_dev.yml
tagcache:
    namespace:                  'Name_Space_For_Your_Project:dev'

# app/config/config_prod.yml
tagcache:
    namespace:                  'Name_Space_For_Your_Project:prod'

driver

The cache driver. Currently support "Memcache,Memcached,File,Sqlite,Apc,Nullcache". Nullcache is for testing only.

hashkey

some driver like Memcached,only support 250 characters key length. Enable this option will use md5 hashed key.

enable_largeobject

Memcache cannot store object over 1MB.Enable these option will fix this issue,but cause lower performance.default false.

servers

Memcache server configs. format => "Host:Port:Weight"

How to Use

Using Tagcache for storing cache data.

<?php
$Tagcache=$container->get('tagcache');

//store cache with Tags:{TagA,TagB} for 300 secs.
$Tagcache->set('Key_For_Store','Data_For_Store',array('TagA','TagB'),300);

//get cache.
$Tagcache->get('Key_For_Store');

//delete cache.
$Tagcache->delete('Key_For_Store');

//delete cache by Tag.
$Tagcache->deleteTag('TagA');

//acquire a lock.If a lock already exists,It will be blocked for 5 secs.
$Tagcache->getLock('Your_Lock_Name',5);

//release a lock.
$Tagcache->releaseLock('Your_Lock_Name');

//increment a cache
$Tagcache->inc('Key_For_increment');

//decrement a cache
$Tagcache->dec('Key_For_decrement');

Controller Cache

Controller Setting

<?php
//in Controller
namespace Acme\DemoBundle\Controller;

// these import the "@Tagcache" annotations
use RickySu\TagcacheBundle\Configuration\Tagcache;

class DemoController extends Controller
{
    /**
     * @Route("/hello/{name}", name="_demo_hello")
     * @Tagcache(expires=600,cache=true)
     * @Template()
     */
    public function helloAction($name)
    {
        return array('name' => $name);
    }

    /**
     * @Route("/test", name="_demo_test")
     * @Tagcache(expires=600,tags={"TagA","TagB"},key="custom_cache_key",cache=true)
     * @Template()
     */
    public function testAction()
    {
        return;
    }
}

View Setting(Twig) (for Symfony 2.1)

{#in view render a controller#}
{%render 'AcmeDemoBundle:Demo:test' with {
     'tagcache':    {
           'key':    'custom_cache_key',
           'tags':   ['TagA','TagB'],
           'expires': 300
     }
}%}

View Setting(Twig) (for Symfony 2.2)

{#in view render a controller#}
{%render(
    controller(
        'AcmeDemoBundle:Demo:test',
        {
            'tagcache':    {
                'key':    'custom_cache_key',
                'tags':   ['TagA','TagB'],   
                'expires': 300
            }
        }
    )
)%}

Your Familiar Partial Cache Comes Back

Clear Cache

app/console cache:clear

Note

If you both define cache params in view and controller. "tagcache" variable in view will overwrite controller annotations. But remember,controller annotation config "cache" must set to false,If you want to turn off controller cache.

TODO

LICENSE

MIT