inspiredminds/contao-future-cache-invalidation

Invalidates cache tags in the future for any DCA in Contao that has a `start` or `stop` field.

1.1.0 2025-03-31 18:43 UTC

Requires

• php: >=8.1
• contao/core-bundle: ^4.13 || ^5.0
• nyholm/psr7: ^1.8
• symfony/config: ^5.4 || ^6.4 || ^7.1
• symfony/dependency-injection: ^5.4 || ^6.4 || ^7.1
• symfony/http-foundation: ^5.4 || ^6.4 || ^7.1
• symfony/http-kernel: ^5.4 || ^6.4 || ^7.1
• symfony/messenger: ^5.4 || ^6.4 || ^7.1

Requires (Dev)

• contao/easy-coding-standard: ^6.0
• contao/rector: ^1.0

LGPL-3.0-or-later

• Fritz Michael Gschwantner

README

Contao Future Cache Invalidation

Invalidates cache tags in the future for any DCA that has a start or stop field.

In Contao 5 you will only need to route the message manually:

# config/config.yaml
framework:
    messenger:
        routing:
            'InspiredMinds\ContaoFutureCacheInvalidation\Message\InvalidateCacheMessage': contao_prio_low

In Contao 4.13 you will also have to create a messenger transport, e.g.:

framework:
    messenger:
        transports:
            cache_invalidation: 'doctrine://default?queue_name=cache_invalidation'
        routing:
            'InspiredMinds\ContaoFutureCacheInvalidation\Message\InvalidateCacheMessage': cache_invalidation

If you use such a doctrine:// transport you will also have to install symfony/doctrine-messenger:

composer require symfony/doctrine-messenger

Then you have to consume the messages somehow via

vendor/bin/contao-console messenger:consume cache_invalidation

e.g. via a crontab entry like this:

* * * * * /usr/bin/php /var/www/example.com/vendor/bin/contao-console messenger:consume cache_invalidation --time-limit=59 --quiet

There is still a caveat: the cache invalidation is based on the contao.db.*.* cache tags. However, this will not work for the start case, as the cache tag would be missing for that URL. For child elements like articles, content elements or news (child of a news archive) it will still work as the extension will also invalidate the tags of the parent. But for pages for example this would not be solved this way - i.e. when you have a start time for page, it would still not show up in the menu of cached pages. In this case the extension clears the whole cache instead.

Note: as this utilizes the Symfony Messenger with its DelayStamp it will only work for the following messenger transport types:

• doctrine
• amqp
• redis