emanueleminotto / twig-cache-bundle
Symfony 2 Bundle for twigphp/twig-cache-extension
Installs: 629 627
Dependents: 5
Suggesters: 0
Security: 0
Stars: 59
Watchers: 9
Forks: 13
Open Issues: 2
Requires
- php: ^7.2|^8.0
- twig/cache-extension: ^1.4
Requires (Dev)
- doctrine/cache: ^1.4
- matthiasnoback/symfony-dependency-injection-test: ^4.2.0
- phpunit/phpunit: ^7.0|^8.0
- symfony/framework-bundle: ^4.0|^5.0
- symfony/twig-bundle: ^4.0|^5.0
Suggests
- cache/adapter-bundle: To make use of PSR-6 cache implementation via PsrCacheAdapter.
- cache/cache-bundle: To easily be able to configure adapters in your Symfony application.
- itinance/doctrine-cache-adapter-with-site-context: a Cache Adapter used to respect the current site context in a white-label/multi-site environment
README
Symfony Bundle for twigphp/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 bundles.php
file of your project:
// bundles.php return [ // ... EmanueleMinotto\TwigCacheBundle\TwigCacheBundle::class => ['all' => true], // ... ];
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