custom/plugins/PickwareDhl/vendor/pickware/document-bundle/src/DocumentEntityWriteValidator.php line 36

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\DocumentBundle;
  14. use Pickware\DalBundle\EntityPreWriteValidationEvent;
  15. use Pickware\DalBundle\EntityPreWriteValidationEventDispatcher;
  16. use Pickware\DocumentBundle\Model\DocumentDefinition;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\DeleteCommand;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  19. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  20. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. use Symfony\Component\Validator\ConstraintViolation;
  22. use Symfony\Component\Validator\ConstraintViolationList;
  24. /**
  25.  * This whole class is there just to ensure that a documents deep link code is exactly 32 characters long.
  26.  */
  27. class DocumentEntityWriteValidator implements EventSubscriberInterface
  28. {
  29.     public static function getSubscribedEvents(): array
  30.     {
  31.         return [
  32.             EntityPreWriteValidationEventDispatcher::getEventName(DocumentDefinition::ENTITY_NAME) => 'onPreWriteValidation',
  33.         ];
  34.     }
  36.     public function onPreWriteValidation($event): void
  37.     {
  38.         if (!($event instanceof EntityPreWriteValidationEvent)) {
  39.             // The subscriber is probably instantiated in its old version (with the Shopware PreWriteValidationEvent) in
  40.             // the container and will be updated on the next container rebuild (next request). Early return.
  41.             return;
  42.         }
  44.         $documentCommands = array_values(array_filter(
  45.             $event->getCommands(),
  46.             fn (WriteCommand $command) => !($command instanceof DeleteCommand),
  47.         ));
  49.         $violations = $this->getDeepLinkCodeViolations($documentCommands);
  51.         if ($violations->count() > 0) {
  52.             $event->addViolation(new WriteConstraintViolationException($violations));
  53.         }
  54.     }
  56.     /**
  57.      * Checks every value of the deepLinkCode properties of the $documentCommands. If they do not have the expected
  58.      * length, an appropriate violation is returned.
  59.      *
  60.      * @param WriteCommand[] $documentCommands
  61.      */
  62.     private function getDeepLinkCodeViolations(array $documentCommands): ConstraintViolationList
  63.     {
  64.         $violationMessageTemplate = 'The length of the property "deepLinkCode" must be exactly {{ length }} characters.';
  65.         $parameters = ['{{ length }}' => DocumentDefinition::DEEP_LINK_CODE_LENGTH];
  66.         $violationMessage = strtr($violationMessageTemplate, $parameters);
  68.         $violations = new ConstraintViolationList();
  69.         foreach ($documentCommands as $documentCommand) {
  70.             $payload = $documentCommand->getPayload();
  71.             if ($documentCommand->getEntityExistence()->exists() && !isset($payload['deep_link_code'])) {
  72.                 // Update without a change of the deepLinkCode
  73.                 continue;
  74.             }
  75.             if (mb_strlen($payload['deep_link_code']) !== DocumentDefinition::DEEP_LINK_CODE_LENGTH) {
  76.                 $violations[] = new ConstraintViolation(
  77.                     $violationMessage,
  78.                     $violationMessageTemplate,
  79.                     $parameters,
  80.                     null, // ???
  81.                     $documentCommand->getPath() . '/deepLinkCode',
  82.                     $payload['deep_link_code'],
  83.                 );
  84.             }
  85.         }
  87.         return $violations;
  88.     }
  89. }