src/Storefront/Framework/Seo/SeoUrlRoute/SeoUrlUpdateListener.php line 38

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Seo\SeoUrlRoute;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Category\CategoryDefinition;
  7. use Shopware\Core\Content\Category\CategoryEvents;
  8. use Shopware\Core\Content\Category\Event\CategoryIndexerEvent;
  9. use Shopware\Core\Content\LandingPage\Event\LandingPageIndexerEvent;
  10. use Shopware\Core\Content\LandingPage\LandingPageEvents;
  11. use Shopware\Core\Content\Product\Events\ProductIndexerEvent;
  12. use Shopware\Core\Content\Product\ProductEvents;
  13. use Shopware\Core\Content\Seo\SeoUrlUpdater;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexerRegistry;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Shopware\Core\Framework\Uuid\Uuid;
  18. use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. /**
  22.  * @internal
  23.  */
  24. #[Package('sales-channel')]
  25. class SeoUrlUpdateListener implements EventSubscriberInterface
  26. {
  27.     final public const CATEGORY_SEO_URL_UPDATER = 'category.seo-url';
  28.     final public const PRODUCT_SEO_URL_UPDATER = 'product.seo-url';
  29.     final public const LANDING_PAGE_SEO_URL_UPDATER = 'landing_page.seo-url';
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(private readonly SeoUrlUpdater $seoUrlUpdater, private readonly Connection $connection, private readonly EntityIndexerRegistry $indexerRegistry)
  35.     {
  36.     }
  38.     public function detectSalesChannelEntryPoints(EntityWrittenContainerEvent $event): void
  39.     {
  40.         $properties = ['navigationCategoryId', 'footerCategoryId', 'serviceCategoryId'];
  42.         $salesChannelIds = $event->getPrimaryKeysWithPropertyChange(SalesChannelDefinition::ENTITY_NAME, $properties);
  44.         if (empty($salesChannelIds)) {
  45.             return;
  46.         }
  48.         $this->indexerRegistry->sendIndexingMessage(['category.indexer', 'product.indexer']);
  49.     }
  51.     /**
  52.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  53.      */
  54.     public static function getSubscribedEvents(): array
  55.     {
  56.         return [
  57.             ProductEvents::PRODUCT_INDEXER_EVENT => 'updateProductUrls',
  58.             CategoryEvents::CATEGORY_INDEXER_EVENT => 'updateCategoryUrls',
  59.             LandingPageEvents::LANDING_PAGE_INDEXER_EVENT => 'updateLandingPageUrls',
  60.             EntityWrittenContainerEvent::class => 'detectSalesChannelEntryPoints',
  61.         ];
  62.     }
  64.     public function updateCategoryUrls(CategoryIndexerEvent $event): void
  65.     {
  66.         if (\in_array(self::CATEGORY_SEO_URL_UPDATER, $event->getSkip(), true)) {
  67.             return;
  68.         }
  70.         $ids = array_merge(array_values($event->getIds()), $this->getCategoryChildren($event->getIds()));
  72.         $this->seoUrlUpdater->update(NavigationPageSeoUrlRoute::ROUTE_NAME, $ids);
  73.     }
  75.     public function updateProductUrls(ProductIndexerEvent $event): void
  76.     {
  77.         if (\in_array(self::PRODUCT_SEO_URL_UPDATER, $event->getSkip(), true)) {
  78.             return;
  79.         }
  81.         $this->seoUrlUpdater->update(ProductPageSeoUrlRoute::ROUTE_NAME, array_values($event->getIds()));
  82.     }
  84.     public function updateLandingPageUrls(LandingPageIndexerEvent $event): void
  85.     {
  86.         if (\in_array(self::LANDING_PAGE_SEO_URL_UPDATER, $event->getSkip(), true)) {
  87.             return;
  88.         }
  90.         $this->seoUrlUpdater->update(LandingPageSeoUrlRoute::ROUTE_NAME, array_values($event->getIds()));
  91.     }
  93.     /**
  94.      * @param list<string> $ids
  95.      *
  96.      * @return list<string>
  97.      */
  98.     private function getCategoryChildren(array $ids): array
  99.     {
  100.         if (empty($ids)) {
  101.             return [];
  102.         }
  104.         $query = $this->connection->createQueryBuilder();
  106.         $query->select('category.id');
  107.         $query->from('category');
  109.         foreach ($ids as $id) {
  110.             $key = 'id' . $id;
  111.             $query->orWhere('category.type != :type AND category.path LIKE :' . $key);
  112.             $query->setParameter($key, '%' . $id . '%');
  113.         }
  115.         $query->setParameter('type', CategoryDefinition::TYPE_LINK);
  117.         $children = $query->executeQuery()->fetchFirstColumn();
  119.         if (!$children) {
  120.             return [];
  121.         }
  123.         /** @var list<string> $ids */
  124.         $ids = Uuid::fromBytesToHexList($children);
  126.         return $ids;
  127.     }
  128. }