Giter Club home page Giter Club logo

twigcachebundle's Introduction

Twig cache extension Bundle

Build Status SensioLabs Insight Coverage Status Scrutinizer Code Quality Total Downloads

Symfony 4 Bundle for 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: 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

twigcachebundle's People

Contributors

emanueleminotto avatar itinance avatar toooni avatar das-peter avatar mente avatar denysmedvid avatar takeit avatar rvanlaak avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.