ShouldUseCachedPageDataIfAvailableEvent¶

New in version 12.0

The PSR-14 event \TYPO3\CMS\Frontend\Event\ShouldUseCachedPageDataIfAvailableEvent allows TYPO3 extensions to register event listeners to modify if a page should be read from cache (if it has been created in store already), or if it should be re-built completely ignoring the cache entry for the request.

This event can be used to avoid loading from the cache when indexing via CLI happens from an external source, or if the cache should be ignored when logged in from a certain IP address.

Example¶

Registration of the event listener in the extension's Services.yaml:

EXT:my_extension/Configuration/Services.yaml

services:
  # Place here the default dependency injection configuration

  MyVendor\MyExtension\Frontend\EventListener\MyEventListener:
    tags:
      - name: event.listener
        identifier: 'my-extension/avoid-cache-loading'

Read how to configure dependency injection in extensions.

The corresponding event listener class:

EXT:my_extension/Classes/Frontend/EventListener/MyEventListener.php

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Frontend\EventListener;

use TYPO3\CMS\Frontend\Event\ShouldUseCachedPageDataIfAvailableEvent;

final class MyEventListener
{
    public function __invoke(ShouldUseCachedPageDataIfAvailableEvent $event): void
    {
        if (!($event->getRequest()->getServerParams()['X-SolR-API'] ?? null)) {
            return;
        }
        $event->setShouldUseCachedPageData(false);
    }
}

API¶

class \TYPO3\CMS\Frontend\Event\ ShouldUseCachedPageDataIfAvailableEvent¶

Event to allow listeners to disable the loading of cached page data when a page is requested.

Does not have any effect if "no_cache" is activated, or if there is no cached version of a page.

getController ( ) ¶

returntype: TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController

getRequest ( ) ¶

returntype: Psr\Http\Message\ServerRequestInterface

shouldUseCachedPageData ( ) ¶

returntype: bool

setShouldUseCachedPageData ( bool $shouldUseCachedPageData) ¶

param bool $shouldUseCachedPageData: the shouldUseCachedPageData