Usage
The "cacheflow" extension provides a command-line interface (CLI) command called cacheflow: for cache
flowing operations. To execute the command, open a terminal or command prompt and navigate to the root directory of your
TYPO3 installation. Then run the following command
typo3 cacheflow:processThe initial run will flow all existing pages, so will take some minutes. After this only the relevant pages are flowed.
See also Run a command from the command line for further explanation of TYPO3 console commands.
Options
-- (optional): Specifies the number of pages per execution. If nothing is set, the default value is 50.
Scheduler Task
After you are familiar with the usage, you can create a Scheduler task, adapt the batch size to the performance of your server and execute the task every minute (with no parallel execution allowed).
Check the TYPO3 manual for Adding or editing a task
Event Dispatcher
The PageRepository dispatches an event which may be used to add AdditionalConstraints which pages should not be crawled. For this you should implement an EventListener for the Event AdditionalConstraintsEvent and provide the additionalConstraint there (which will be appended with logical AND to the given constraints)
e.g. ```<?php
namespace YourVendorYourExtensionEventListener;
use TYPO3CMSCoreAttributeAsEventListener; use TYPO3CMSCoreDatabaseConnection; use F7mediaCacheflowEventAdditionalConstraintsEvent;
- #[AsEventListener(
- identifier: 'yourextension/cacheflow-additional-constraint'
)] final readonly class CacheFlowAdditionalConstraintEventListener { public function __invoke(AdditionalConstraintsEvent $event): void {
$queryBuilder = $event->getQueryBuilder();
/ Don't flow pages from doctype 15 which are hidden in the menu / // p.* are the properties of the pages table $additionalConstraint = $queryBuilder->expr()->or( $queryBuilder->expr()->neq('p.doktype', $queryBuilder->createNamedParameter(15, Connection::PARAM_INT)), $queryBuilder->expr()->eq('p.nav_hide', $queryBuilder->createNamedParameter(1, Connection::PARAM_INT)), );
$event->setAdditionalConstraint($additionalConstraint);
} }
`
Dashboard widget
System maintainers can keep an overview by adding a prepared dashboard widget to the TYPO3 backend.
Just use the wizard to add the widget Cache.
More on Adding Dashboard