custom/plugins/SwagCustomizedProducts/src/Storefront/Page/Product/ProductPageSubscriber.php line 122

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. /*
  3.  * (c) shopware AG <info@shopware.com>
  4.  * For the full copyright and license information, please view the LICENSE
  5.  * file that was distributed with this source code.
  6.  */
  8. namespace Swag\CustomizedProducts\Storefront\Page\Product;
  10. use Shopware\Core\Content\Media\MediaEntity;
  11. use Shopware\Core\Content\Product\ProductEntity;
  12. use Shopware\Core\Framework\Context;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Storefront\Page\Product\ProductPageLoadedEvent;
  18. use Swag\CustomizedProducts\Core\Content\Product\ProductWrittenSubscriber;
  19. use Swag\CustomizedProducts\Migration\Migration1565933910TemplateProduct;
  20. use Swag\CustomizedProducts\Storefront\Page\Product\Extensions\EditConfigurationExtension;
  21. use Swag\CustomizedProducts\Storefront\Page\Product\Extensions\ShareConfigurationExtension;
  22. use Swag\CustomizedProducts\Template\Aggregate\TemplateConfiguration\Aggregate\TemplateConfigurationShareEntity;
  23. use Swag\CustomizedProducts\Template\Aggregate\TemplateConfiguration\Service\TemplateConfigurationService;
  24. use Swag\CustomizedProducts\Template\Aggregate\TemplateConfiguration\TemplateConfigurationEntity;
  25. use Swag\CustomizedProducts\Template\SalesChannel\Price\PriceService;
  26. use Swag\CustomizedProducts\Template\TemplateEntity;
  27. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  28. use Symfony\Component\HttpFoundation\Session\Session;
  29. use Symfony\Contracts\Translation\TranslatorInterface;
  31. class ProductPageSubscriber implements EventSubscriberInterface
  32. {
  33.     public const EDIT_CONFIGURATION_PARAMETER = 'swagCustomizedProductsConfigurationEdit';
  34.     public const SHARE_CONFIGURATION_PARAMETER = 'swagCustomizedProductsConfigurationShare';
  36.     /**
  37.      * @var EntityRepositoryInterface
  38.      */
  39.     private $productRepository;
  41.     /**
  42.      * @var PriceService
  43.      */
  44.     private $priceService;
  46.     /**
  47.      * @var EntityRepositoryInterface
  48.      */
  49.     private $configurationRepository;
  51.     /**
  52.      * @var EntityRepositoryInterface
  53.      */
  54.     private $configurationShareRepository;
  56.     /**
  57.      * @var Session
  58.      */
  59.     private $session;
  61.     /**
  62.      * @var TranslatorInterface
  63.      */
  64.     private $translator;
  66.     /**
  67.      * @var TemplateConfigurationService
  68.      */
  69.     private $configurationService;
  71.     /**
  72.      * @var EntityRepositoryInterface
  73.      */
  74.     private $mediaRepository;
  76.     public function __construct(
  77.         EntityRepositoryInterface $productRepository,
  78.         PriceService $priceService,
  79.         EntityRepositoryInterface $configurationRepository,
  80.         EntityRepositoryInterface $configurationShareRepository,
  81.         Session $session,
  82.         TranslatorInterface $translator,
  83.         TemplateConfigurationService $configurationService,
  84.         EntityRepositoryInterface $mediaRepository
  85.     ) {
  86.         $this->productRepository = $productRepository;
  87.         $this->priceService = $priceService;
  88.         $this->configurationRepository = $configurationRepository;
  89.         $this->configurationShareRepository = $configurationShareRepository;
  90.         $this->session = $session;
  91.         $this->translator = $translator;
  92.         $this->configurationService = $configurationService;
  93.         $this->mediaRepository = $mediaRepository;
  94.     }
  96.     public static function getSubscribedEvents(): array
  97.     {
  98.         return [
  99.             ProductPageLoadedEvent::class => [
  100.                 ['addMediaToTemplate', 500],
  101.                 ['removeCustomizedProductsTemplateFromNoneInheritedVariant', 400],
  102.                 ['enrichOptionPriceAbleDisplayPrices', 300],
  103.                 ['addEditConfigurationExtension', 200],
  104.                 ['addShareConfigurationExtension', 100],
  105.             ],
  106.         ];
  107.     }
  109.     /**
  110.      * @deprecated tag:v4.0.0 Will be removed use addMediaToTemplate instead.
  111.      */
  112.     public function addCustomizedProductsDetailAssociations(ProductPageLoadedEvent $event): void
  113.     {
  114.         $this->addMediaToTemplate($event);
  115.     }
  117.     /**
  118.      * Please bear in mind, that the SalesChannelProductRepository gets decorated here: Swag\CustomizedProducts\Core\Content\Product\SalesChannel\SalesChannelProductRepositoryDecorator
  119.      * And that the SalesChannelTemplateDefinition requires all associations except the media per default here: Swag\CustomizedProducts\Template\SalesChannel\SalesChannelTemplateDefinition::processCriteria
  120.      * For better performance we only load the media once its needed on the product detail page.
  121.      */
  122.     public function addMediaToTemplate(ProductPageLoadedEvent $event): void
  123.     {
  124.         try {
  125.             /** @var TemplateEntity|null $template */
  126.             $template = $event->getPage()
  127.                 ->getProduct()
  128.                 ->get(Migration1565933910TemplateProduct::PRODUCT_TEMPLATE_INHERITANCE_COLUMN);
  129.         } catch (\InvalidArgumentException $e) {
  130.             return;
  131.         }
  133.         if ($template === null) {
  134.             return;
  135.         }
  137.         $criteria = new Criteria();
  138.         $criteria->setLimit(1);
  139.         $criteria->addFilter(
  140.             new EqualsFilter('swagCustomizedProductsTemplate.id', $template->getId())
  141.         );
  143.         /** @var MediaEntity|null $media */
  144.         $media = $this->mediaRepository->search($criteria, $event->getSalesChannelContext()->getContext())->first();
  145.         if ($media === null) {
  146.             return;
  147.         }
  149.         $template->setMediaId($media->getId());
  150.         $template->setMedia($media);
  151.     }
  153.     public function removeCustomizedProductsTemplateFromNoneInheritedVariant(ProductPageLoadedEvent $event): void
  154.     {
  155.         $product = $event->getPage()->getProduct();
  156.         $parentId = $product->getParentId();
  158.         if ($parentId === null) {
  159.             return;
  160.         }
  162.         $customFields = $product->getCustomFields();
  163.         if ($customFields === null
  164.             || !\array_key_exists(ProductWrittenSubscriber::SWAG_CUSTOMIZED_PRODUCTS_TEMPLATE_INHERITED_CUSTOM_FIELD, $customFields)
  165.         ) {
  166.             return;
  167.         }
  169.         if ($customFields[ProductWrittenSubscriber::SWAG_CUSTOMIZED_PRODUCTS_TEMPLATE_INHERITED_CUSTOM_FIELD]) {
  170.             return;
  171.         }
  173.         if ($this->variantHasOwnTemplateAssigned($product->getId(), $event->getContext())) {
  174.             return;
  175.         }
  177.         $product->removeExtension(Migration1565933910TemplateProduct::PRODUCT_TEMPLATE_INHERITANCE_COLUMN);
  178.     }
  180.     public function enrichOptionPriceAbleDisplayPrices(ProductPageLoadedEvent $event): void
  181.     {
  182.         /** @var TemplateEntity|null $customizedProductsTemplate */
  183.         $customizedProductsTemplate = $event->getPage()->getProduct()->getExtension(Migration1565933910TemplateProduct::PRODUCT_TEMPLATE_INHERITANCE_COLUMN);
  185.         if ($customizedProductsTemplate === null) {
  186.             return;
  187.         }
  189.         $this->priceService->calculateCurrencyPrices($customizedProductsTemplate, $event->getSalesChannelContext());
  190.     }
  192.     public function addEditConfigurationExtension(ProductPageLoadedEvent $event): void
  193.     {
  194.         $query = $event->getRequest()->query;
  195.         if (!$query->has(self::EDIT_CONFIGURATION_PARAMETER)) {
  196.             return;
  197.         }
  199.         $configurationId = $query->getAlnum(self::EDIT_CONFIGURATION_PARAMETER);
  200.         if (!Uuid::isValid($configurationId)) {
  201.             return;
  202.         }
  204.         $context = $event->getContext();
  205.         $configuration = $this->getConfiguration($configurationId, $context);
  206.         if ($configuration === null) {
  207.             $this->session->getFlashBag()->add(
  208.                 'info',
  209.                 $this->translator->trans('customizedProducts.configurationEdit.notRestorable')
  210.             );
  212.             return;
  213.         }
  215.         if (!$this->configurationService->isConfigurationFullyRestorable($configuration, $context)) {
  216.             $this->session->getFlashBag()->add(
  217.                 'info',
  218.                 $this->translator->trans('customizedProducts.configurationEdit.notFullyRestorable')
  219.             );
  220.         }
  222.         $editConfigurationExtension = (new EditConfigurationExtension())->assign([
  223.             'oldHash' => $configuration->getHash(),
  224.             'configuration' => $configuration->getConfiguration(),
  225.         ]);
  227.         $event->getPage()->addExtension(self::EDIT_CONFIGURATION_PARAMETER, $editConfigurationExtension);
  228.     }
  230.     public function addShareConfigurationExtension(ProductPageLoadedEvent $event): void
  231.     {
  232.         $context = $event->getContext();
  233.         $query = $event->getRequest()->query;
  234.         if (!$query->has(self::SHARE_CONFIGURATION_PARAMETER)) {
  235.             return;
  236.         }
  238.         $shareId = $query->getAlnum(self::SHARE_CONFIGURATION_PARAMETER);
  239.         if (!Uuid::isValid($shareId)) {
  240.             return;
  241.         }
  243.         $configurationShare = $this->getShare($shareId, $context);
  244.         if ($configurationShare === null) {
  245.             $this->session->getFlashBag()->add(
  246.                 'info',
  247.                 $this->translator->trans('customizedProducts.configurationShare.unavailable')
  248.             );
  250.             return;
  251.         }
  253.         $shareConfigurationExtension = (new ShareConfigurationExtension())->assign([
  254.             'configuration' => $configurationShare->getTemplateConfiguration()->getConfiguration(),
  255.         ]);
  257.         $event->getPage()->addExtension(self::SHARE_CONFIGURATION_PARAMETER, $shareConfigurationExtension);
  259.         if ($configurationShare->isOneTime()) {
  260.             $this->configurationShareRepository->delete([['id' => $configurationShare->getId()]], $context);
  261.         }
  262.     }
  264.     private function variantHasOwnTemplateAssigned(string $id, Context $context): bool
  265.     {
  266.         $considerInheritance = $context->considerInheritance();
  267.         $criteria = new Criteria([$id]);
  268.         $criteria->addAssociation(Migration1565933910TemplateProduct::PRODUCT_TEMPLATE_INHERITANCE_COLUMN);
  269.         $criteria->setLimit(1);
  270.         $context->setConsiderInheritance(false);
  272.         /** @var ProductEntity|null $product */
  273.         $product = $this->productRepository->search($criteria, $context)->first();
  274.         $context->setConsiderInheritance($considerInheritance);
  276.         if ($product === null) {
  277.             return false;
  278.         }
  280.         return $product->hasExtension(Migration1565933910TemplateProduct::PRODUCT_TEMPLATE_INHERITANCE_COLUMN);
  281.     }
  283.     private function getConfiguration(string $configurationId, Context $context): ?TemplateConfigurationEntity
  284.     {
  285.         $criteria = new Criteria([$configurationId]);
  287.         return $this->configurationRepository->search($criteria, $context)->first();
  288.     }
  290.     private function getShare(string $shareId, Context $context): ?TemplateConfigurationShareEntity
  291.     {
  292.         $criteria = new Criteria([$shareId]);
  293.         $criteria->addAssociation('templateConfiguration');
  295.         return $this->configurationShareRepository->search($criteria, $context)->first();
  296.     }
  297. }