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

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