src/Core/Content/Seo/SalesChannel/StoreApiSeoResolver.php line 55

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Seo\SalesChannel;
  5. use Shopware\Core\Content\Category\CategoryEntity;
  6. use Shopware\Core\Content\Product\SalesChannel\SalesChannelProductEntity;
  7. use Shopware\Core\Content\Seo\SeoUrl\SeoUrlCollection;
  8. use Shopware\Core\Content\Seo\SeoUrl\SeoUrlEntity;
  9. use Shopware\Core\Content\Seo\SeoUrlRoute\SeoUrlRouteInterface as SeoUrlRouteConfigRoute;
  10. use Shopware\Core\Content\Seo\SeoUrlRoute\SeoUrlRouteRegistry;
  11. use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\Sorting\FieldSorting;
  19. use Shopware\Core\Framework\Log\Package;
  20. use Shopware\Core\Framework\Struct\Collection;
  21. use Shopware\Core\Framework\Struct\Struct;
  22. use Shopware\Core\PlatformRequest;
  23. use Shopware\Core\System\SalesChannel\Entity\SalesChannelDefinitionInstanceRegistry;
  24. use Shopware\Core\System\SalesChannel\Entity\SalesChannelRepository;
  25. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  26. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  27. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  28. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  29. use Symfony\Component\HttpKernel\KernelEvents;
  31. /**
  32.  * @internal
  33.  */
  34. #[Package('sales-channel')]
  35. class StoreApiSeoResolver implements EventSubscriberInterface
  36. {
  37.     /**
  38.      * @internal
  39.      */
  40.     public function __construct(
  41.         private readonly SalesChannelRepository $salesChannelRepository,
  42.         private readonly DefinitionInstanceRegistry $definitionInstanceRegistry,
  43.         private readonly SalesChannelDefinitionInstanceRegistry $salesChannelDefinitionInstanceRegistry,
  44.         private readonly SeoUrlRouteRegistry $seoUrlRouteRegistry
  45.     ) {
  46.     }
  48.     public static function getSubscribedEvents(): array
  49.     {
  50.         return [
  51.             KernelEvents::RESPONSE => ['addSeoInformation', 10000],
  52.         ];
  53.     }
  55.     public function addSeoInformation(ResponseEvent $event): void
  56.     {
  57.         $response = $event->getResponse();
  59.         if (!$response instanceof StoreApiResponse) {
  60.             return;
  61.         }
  63.         if (!$event->getRequest()->headers->has(PlatformRequest::HEADER_INCLUDE_SEO_URLS)) {
  64.             return;
  65.         }
  67.         $dataBag = new SeoResolverData();
  69.         $this->find($dataBag, $response->getObject());
  70.         $this->enrich($dataBag, $event->getRequest()->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT));
  71.     }
  73.     private function find(SeoResolverData $data, Struct $struct): void
  74.     {
  75.         if ($struct instanceof AggregationResultCollection) {
  76.             foreach ($struct as $item) {
  77.                 $this->findStruct($data, $item);
  78.             }
  79.         }
  81.         if ($struct instanceof EntitySearchResult) {
  82.             foreach ($struct->getEntities() as $entity) {
  83.                 $this->findStruct($data, $entity);
  84.             }
  85.         }
  87.         if ($struct instanceof Collection) {
  88.             foreach ($struct as $item) {
  89.                 $this->findStruct($data, $item);
  90.             }
  91.         }
  93.         $this->findStruct($data, $struct);
  94.     }
  96.     private function findStruct(SeoResolverData $data, Struct $struct): void
  97.     {
  98.         if ($struct instanceof Entity) {
  99.             $definition = $this->definitionInstanceRegistry->getByEntityClass($struct) ?? $this->salesChannelDefinitionInstanceRegistry->getByEntityClass($struct);
  100.             if ($definition && $definition->isSeoAware()) {
  101.                 $data->add($definition->getEntityName(), $struct);
  102.             }
  103.         }
  105.         foreach ($struct->getVars() as $item) {
  106.             if ($item instanceof Collection) {
  107.                 foreach ($item as $collectionItem) {
  108.                     if ($collectionItem instanceof Struct) {
  109.                         $this->findStruct($data, $collectionItem);
  110.                     }
  111.                 }
  112.             } elseif ($item instanceof Struct) {
  113.                 $this->findStruct($data, $item);
  114.             }
  115.         }
  116.     }
  118.     private function enrich(SeoResolverData $data, SalesChannelContext $context): void
  119.     {
  120.         foreach ($data->getEntities() as $definition) {
  121.             $definition = (string) $definition;
  123.             $ids = $data->getIds($definition);
  124.             $routes = $this->seoUrlRouteRegistry->findByDefinition($definition);
  125.             if (\count($routes) === 0) {
  126.                 continue;
  127.             }
  129.             $routes = array_map(static fn (SeoUrlRouteConfigRoute $seoUrlRoute) => $seoUrlRoute->getConfig()->getRouteName(), $routes);
  131.             $criteria = new Criteria();
  132.             $criteria->addFilter(new EqualsFilter('isCanonical', true));
  133.             $criteria->addFilter(new EqualsAnyFilter('routeName', $routes));
  134.             $criteria->addFilter(new EqualsAnyFilter('foreignKey', $ids));
  135.             $criteria->addFilter(new EqualsFilter('languageId', $context->getContext()->getLanguageId()));
  136.             $criteria->addSorting(new FieldSorting('salesChannelId'));
  138.             /** @var SeoUrlEntity $url */
  139.             foreach ($this->salesChannelRepository->search($criteria, $context) as $url) {
  140.                 /** @var SalesChannelProductEntity|CategoryEntity $entity */
  141.                 $entity = $data->get($definition, $url->getForeignKey());
  143.                 if ($entity->getSeoUrls() === null) {
  144.                     $entity->setSeoUrls(new SeoUrlCollection());
  145.                 }
  147.                 /** @phpstan-ignore-next-line - will complain that 'getSeoUrls' might be null, but we will set it if it is null */
  148.                 $entity->getSeoUrls()->add($url);
  149.             }
  150.         }
  151.     }
  152. }