teamneusta/pimcore-http-cache-bundle

Adds active cache invalidation to pimcore via cache tags.

dev-main 2025-05-28 13:28 UTC

Requires

• php: ~8.1.0 || ~8.2.0
• friendsofsymfony/http-cache: ^2.16
• friendsofsymfony/http-cache-bundle: ^2.17
• pimcore/pimcore: ^10.6 || ^11.2
• psr/log: ^1.0 || ^2.0 || ^3.0
• symfony/config: ^5.4 || ^6.4
• symfony/contracts: ^2.5 || ^3.5
• symfony/dependency-injection: ^5.4 || ^6.4
• symfony/event-dispatcher: ^5.4 || ^6.4
• symfony/http-kernel: ^5.4 || ^6.4
• symfony/messenger: ^5.4 || ^6.4

Requires (Dev)

• dg/bypass-finals: ^1.9
• ergebnis/composer-normalize: ^2.45
• friendsofphp/php-cs-fixer: ^3.71
• jangregor/phpstan-prophecy: ^1.0
• laminas/laminas-zendframework-bridge: ^1.8
• phpspec/prophecy: ^1.20
• phpspec/prophecy-phpunit: ^2.3
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^1.12
• phpstan/phpstan-phpunit: ^1.4
• phpstan/phpstan-symfony: ^1.4
• phpunit/phpunit: ^9.6
• symfony/browser-kit: ^5.4 || ^6.4
• teamneusta/pimcore-testing-framework: ^0.12.10

Conflicts

• jms/serializer-bundle: <4.2
• masterminds/html5: <2.7.5
• phpspec/prophecy: <1.15.0
• webmozart/assert: <1.11

GPL-3.0-or-later

• team neusta GmbH

README

This bundle provides a simple way to handle cache invalidation for Pimcore elements. The Bundle relies on the FOSHttpCacheBundle, which is used to manage a reverse proxy HTTP cache.

What is an HTTP Reverse Proxy?

An HTTP reverse proxy is a server that sits between your web application and the internet. Instead of serving content directly to clients, it forwards requests to the origin server (your web application) and caches the responses. When the same request comes again, it can serve the cached response directly, reducing load on your origin server and improving response times.

What is FOS HTTP Cache Bundle?

The FOSHttpCacheBundle is a Symfony bundle that helps manage HTTP caching using reverse proxies. It provides tools to:

• Invalidate cached content when data changes
• Configure cache headers
• Handle cache tags and variations
• Integrate with various reverse proxy solutions (like Varnish, Fastly, etc.)

What does this Bundle do?

This bundle extends the functionality of FOSHttpCacheBundle specifically for Pimcore. It:

• Automatically handles cache invalidation for Pimcore elements (documents, assets, objects)
• Provides Pimcore-specific cache tags and variations
• Integrates seamlessly with Pimcore's event system
• Offers custom cache types for different use cases
• Allows for fine-grained control over caching behavior

In essence, this bundle makes it easy to implement efficient HTTP caching in your Pimcore application while maintaining proper cache invalidation when your content changes.

Documentation

You will find the detailed documentation in the following links:

• Installation
• Configuration
• Pimcore elements
• Events
• Additional tags
• Cancel caching behavior
• Custom cache types
• Disabling caching behavior
• Error handling
• Contribution

We hope you will enjoy this bundle as much as we do. If you have any questions or suggestions, please feel free to open an issue on GitHub. This repository is maintained by neusta.

Happy caching!