custom/plugins/PickwareErpStarter/vendor/pickware/dal-bundle/src/EntityPreWriteValidationEventDispatcher.php line 59

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright (c) Pickware GmbH. All rights reserved.
  4.  * This file is part of software that is released under a proprietary license.
  5.  * You must not copy, modify, distribute, make publicly available, or execute
  6.  * its contents or parts thereof without express permission by the copyright
  7.  * holder, unless otherwise permitted by law.
  8.  */
  10. declare(strict_types=1);
  12. namespace Pickware\DalBundle;
  14. use Psr\EventDispatcher\EventDispatcherInterface;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. /**
  19.  * Shopware dispatches only one "pre_write_validation" event for each call to the DAL (like entity create, update or
  20.  * delete). The same event is dispatched for every entity that is written at once, so subscribers listening on this
  21.  * event then need to be instantiated in the container even if they do not need information about the entity in
  22.  * question. Only after their instantiation they can decide whether to act or not.
  23.  *
  24.  * This dispatcher and the new event being only scoped on individual entities solves this problem by allowing subscribers
  25.  * to specify the concerned entities before their instantiation. This means that the symfony DI container will not
  26.  * instantiate a subscriber if the subscriber will not act on the event.
  27.  *
  28.  * During plugin updates, the "plugin" entity is updated and thus a "pre_write_validation" event is dispatched. When
  29.  * listening on the old event, subscribers were instantiated even if they did not act on the "plugin" entity. As during
  30.  * a plugin update the code is updated before the container refreshes, the container might try to instantiate a
  31.  * subscriber with invalid constructor parameters. This leads to a (from the admin irrecoverable) container crash. With
  32.  * the new event, the subscriber is not instantiated and thus the container does not crash.
  33.  *
  34.  * This also prevents subscribers from requesting change-sets for every entity and uncovers missing change-set requests.
  35.  *
  36.  * See:
  37.  * - https://github.com/pickware/shopware-plugins/issues/3500
  38.  * - https://github.com/pickware/shopware-plugins/issues/2764
  39.  */
  40. class EntityPreWriteValidationEventDispatcher implements EventSubscriberInterface
  41. {
  42.     private EventDispatcherInterface $eventDispatcher;
  44.     public function __construct(EventDispatcherInterface $eventDispatcher)
  45.     {
  46.         $this->eventDispatcher = $eventDispatcher;
  47.     }
  49.     public static function getSubscribedEvents(): array
  50.     {
  51.         return [PreWriteValidationEvent::class => 'onPreWriteValidation'];
  52.     }
  54.     public static function getEventName(string $entityName): string
  55.     {
  56.         return sprintf('pickware_dal_bundle.%s.pre_write_validation', $entityName);
  57.     }
  59.     public function onPreWriteValidation(PreWriteValidationEvent $event): void
  60.     {
  61.         $writeCommandsByEntityNames = [];
  62.         $definitionClassNamesByEntityNames = [];
  63.         foreach ($event->getCommands() as $command) {
  64.             $entityName = $command->getDefinition()->getEntityName();
  65.             $writeCommandsByEntityNames[$entityName] ??= [];
  66.             $writeCommandsByEntityNames[$entityName][] = $command;
  67.             $definitionClassNamesByEntityNames[$entityName] = $command->getDefinition()->getClass();
  68.         }
  70.         foreach ($writeCommandsByEntityNames as $entityName => $writeCommands) {
  71.             /** @var EntityPreWriteValidationEvent $entityPreWriteValidationEvent */
  72.             $entityPreWriteValidationEvent = $this->eventDispatcher->dispatch(
  73.                 new EntityPreWriteValidationEvent(
  74.                     $event->getWriteContext(),
  75.                     $writeCommands,
  76.                     $definitionClassNamesByEntityNames[$entityName],
  77.                 ),
  78.                 self::getEventName($entityName),
  79.             );
  81.             foreach ($entityPreWriteValidationEvent->getViolations() as $violation) {
  82.                 $event->getExceptions()->add($violation);
  83.             }
  84.         }
  85.     }
  86. }