src/Core/Framework/Routing/CanonicalRedirectService.php line 32

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Routing;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\SalesChannelRequest;
  7. use Shopware\Core\System\SystemConfig\SystemConfigService;
  8. use Symfony\Component\HttpFoundation\RedirectResponse;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpFoundation\Response;
  12. #[Package('core')]
  13. class CanonicalRedirectService
  14. {
  15.     /**
  16.      * @internal
  17.      */
  18.     public function __construct(private readonly SystemConfigService $configService)
  19.     {
  20.     }
  22.     /**
  23.      * getRedirect takes a request processed by the RequestTransformer and checks,
  24.      * whether it points to a SEO-URL which has been superseded. In case the corresponding
  25.      * configuration option is active, it returns a redirect response to indicate, that
  26.      * the request should be redirected to the canonical URL.
  27.      */
  28.     public function getRedirect(Request $request): ?Response
  29.     {
  30.         // This attribute has been set by the RequestTransformer if the requested URL was superseded.
  31.         $canonical = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_CANONICAL_LINK);
  32.         $shouldRedirect = $this->configService->get('core.seo.redirectToCanonicalUrl');
  34.         if (!$shouldRedirect) {
  35.             return null;
  36.         }
  38.         if (empty($canonical)) {
  39.             return null;
  40.         }
  42.         $queryString = $request->getQueryString();
  44.         if ($queryString) {
  45.             $canonical = sprintf('%s?%s', $canonical, $queryString);
  46.         }
  48.         return new RedirectResponse($canonical, Response::HTTP_MOVED_PERMANENTLY);
  49.     }
  50. }