RedirectWasHitEvent¶
New in version 12.0.
The PSR-14 event \TYPO3\CMS\Redirects\Event\RedirectWasHitEvent
is fired
in the \TYPO3\CMS\Redirects\Http\Middleware\RedirectHandler
middleware and allows extension authors to further
process the matched redirect and to adjust the PSR-7 response.
Example: Disable the hit count increment for monitoring tools¶
TYPO3 already implements the EXT:redirects/Classes/EventListener/IncrementHitCount.php
listener. It is used to increment the hit count of the matching redirect record,
if the feature "redirects.hitCount"
is enabled. In case you want to prevent the increment in some
cases, for example if the request was initiated by a monitoring tool, you
can either implement your own listener with the same identifier
(redirects-increment-hit-count
) or add your custom listener
before and dynamically set the records disable_hitcount
flag.
Registration of the event listener in the extension's Services.yaml
:
MyVendor\MyExtension\Redirects\EventListener\MyEventListener:
tags:
- name: event.listener
identifier: 'my-extension/redirects/validate-hit-count'
before: 'redirects-increment-hit-count'
The corresponding event listener class:
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\Redirects\EventListener;
use TYPO3\CMS\Redirects\Event\RedirectWasHitEvent;
final class MyEventListener
{
public function __invoke(RedirectWasHitEvent $event): void
{
$matchedRedirect = $event->getMatchedRedirect();
// This will disable the hit count increment in case the target
// is the page 123 and the request is from the monitoring tool.
if (str_contains($matchedRedirect['target'], 'uid=123')
&& $event->getRequest()->getAttribute('normalizedParams')
->getHttpUserAgent() === 'my monitoring tool'
) {
$matchedRedirect['disable_hitcount'] = true;
$event->setMatchedRedirect(
$matchedRedirect
);
// Also add a custom response header
$event->setResponse(
$event->getResponse()->withAddedHeader(
'X-My-Custom-Header',
'Hit count increment skipped'
)
);
}
}
}
API¶
- class TYPO3\CMS\Redirects\Event\RedirectWasHitEvent¶
This event is fired in the TYPO3CMSRedirectsHttpMiddlewareRedirectHandler middleware when a request matches a configured redirect.
It can be used to further process the matched redirect and to adjust the PSR-7 Response. It furthermore allows to influence Core functionality, for example the hit count increment.
- getRequest()¶
- Return type
Psr\Http\Message\ServerRequestInterface
- getTargetUrl()¶
- Return type
Psr\Http\Message\UriInterface
- setMatchedRedirect(array $matchedRedirect)¶
- Parameters
$matchedRedirect (
array
) -- the matchedRedirect
- getMatchedRedirect()¶
- Return type
array
- setResponse(Psr\\Http\\Message\\ResponseInterface $response)¶
- Parameters
$response (
Psr\Http\Message\ResponseInterface
) -- the response
- getResponse()¶
- Return type
Psr\Http\Message\ResponseInterface