Skip to content
Symfony Bundle for asm89/twig-cache-extension
PHP HTML Shell
Branch: master
Clone or download
Latest commit f5188a3 Jul 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
DataCollector Splitted data collector from extension Mar 30, 2018
DependencyInjection Splitted data collector from extension Mar 30, 2018
KeyGenerator php-cs-fix Mar 30, 2018
Resources Splitted data collector from extension Mar 30, 2018
Strategy Splitted data collector from extension Mar 30, 2018
Tests Splitted data collector from extension Mar 30, 2018
.coveralls.yml code utilities Feb 8, 2015
.editorconfig added the editorconfig utility Sep 12, 2015
.gitignore Remove .idea Jun 1, 2018
.travis.yml Update unsupported elements Aug 3, 2017
README.md Document PSR-6 cache adapters Jun 28, 2016
TwigCacheBundle.php first commit Jan 27, 2015
composer.json Removed deprecations Aug 3, 2017
generate-api.sh code utilities Feb 8, 2015
phpunit.xml.dist

README.md

Twig cache extension Bundle

Build Status SensioLabs Insight Coverage Status Scrutinizer Code Quality Total Downloads

Symfony Bundle for asm89/twig-cache-extension.

API: emanueleminotto.github.io/TwigCacheBundle

Install bundle using Composer

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require emanueleminotto/twig-cache-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Add Bundle to AppKernel

Then, enable the bundle by adding the following line in the app/AppKernel.php file of your project:

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new EmanueleMinotto\TwigCacheBundle\TwigCacheBundle(),
        );
    }
}

Configure services

This bundle allows to easily configure the caching service the extension will use for the caching. The extension by default supports instances of Doctrine\Common\Cache\Cache but allows you to use packages that provide a psr/cache-implementation.

# app/config/config.yml
twig_cache:
    service: cache_service # instance of Doctrine\Common\Cache\Cache or Psr\Cache\CacheItemPoolInterface

Configuring a PSR-6 Cache pool implementation is possible by changing the extension's default adapter class to the PsrCacheAdapter that is provided with the extension.

# parameters.yml
twig_cache.adapter.class: Asm89\Twig\CacheExtension\CacheProvider\PsrCacheAdapter

After that, you should install a package that provides a psr/cache-implementation. A wide variety of implementations already can be found at: http://php-cache.readthedocs.io/ After installing an adapter with composer, it can be configured to do the caching for this bundle. The CacheBundle allows easy configuration by creating a Symfony service for the cache pool adapter.

# config.yml
cache_adapter:
    providers:
        twig_apcu:
            factory: 'cache.factory.apcu'

twig_cache:
    service: cache.provider.twig_apcu

Usage

The default strategy is the IndexedChainingCacheStrategy so you can use directly this code in your Twig templates.

{# delegate to lifetime strategy #}
{% cache 'v1/summary' {time: 300} %}
    {# heavy lifting template stuff here, include/render other partials etc #}
{% endcache %}

{# delegate to generational strategy #}
{% cache 'v1/summary' {gen: item} %}
    {# heavy lifting template stuff here, include/render other partials etc #}
{% endcache %}

Readings:

License

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

Resources/meta/LICENSE
You can’t perform that action at this time.