vendor/shopware/core/Checkout/Shipping/Validator/ShippingMethodValidator.php line 48

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Shipping\Validator;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Checkout\Shipping\ShippingMethodDefinition;
  7. use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  13. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. use Symfony\Component\Validator\ConstraintViolation;
  15. use Symfony\Component\Validator\ConstraintViolationInterface;
  16. use Symfony\Component\Validator\ConstraintViolationList;
  18. /**
  19. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  20. */
  21. #[Package('checkout')]
  22. class ShippingMethodValidator implements EventSubscriberInterface
  23. {
  24. public const VIOLATION_TAX_TYPE_INVALID = 'tax_type_invalid';
  26. public const VIOLATION_TAX_ID_REQUIRED = 'c1051bb4-d103-4f74-8988-acbcafc7fdc3';
  28. private Connection $connection;
  30. /**
  31. * @internal
  32. */
  33. public function __construct(Connection $connection)
  34. {
  35. $this->connection = $connection;
  36. }
  38. /**
  39. * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  40. */
  41. public static function getSubscribedEvents()
  42. {
  43. return [
  44. PreWriteValidationEvent::class => 'preValidate',
  45. ];
  46. }
  48. public function preValidate(PreWriteValidationEvent $event): void
  49. {
  50. $allowTypes = [
  51. ShippingMethodEntity::TAX_TYPE_FIXED,
  52. ShippingMethodEntity::TAX_TYPE_AUTO,
  53. ShippingMethodEntity::TAX_TYPE_HIGHEST,
  54. ];
  56. $writeCommands = $event->getCommands();
  58. foreach ($writeCommands as $command) {
  59. $violations = new ConstraintViolationList();
  61. if (!$command instanceof InsertCommand && !$command instanceof UpdateCommand) {
  62. continue;
  63. }
  65. if ($command->getDefinition()->getClass() !== ShippingMethodDefinition::class) {
  66. continue;
  67. }
  69. $shippingMethod = $this->findShippingMethod($command->getPrimaryKey()['id']);
  71. $payload = $command->getPayload();
  73. /** @var string|null $taxType */
  74. $taxType = $this->getValue($payload, 'tax_type', $shippingMethod);
  76. /** @var string|null $taxId */
  77. $taxId = $this->getValue($payload, 'tax_id', $shippingMethod);
  79. if ($taxType && !\in_array($taxType, $allowTypes, true)) {
  80. $violations->add(
  81. $this->buildViolation(
  82. 'The selected tax type {{ type }} is invalid.',
  83. ['{{ type }}' => $taxType],
  84. '/taxType',
  85. $taxType,
  86. self::VIOLATION_TAX_TYPE_INVALID
  87. )
  88. );
  89. }
  91. if ($taxType === ShippingMethodEntity::TAX_TYPE_FIXED && !$taxId) {
  92. $violations->add(
  93. $this->buildViolation(
  94. 'The defined tax rate is required when fixed tax present',
  95. ['{{ taxId }}' => null],
  96. '/taxId',
  97. $taxType,
  98. self::VIOLATION_TAX_ID_REQUIRED
  99. )
  100. );
  101. }
  103. if ($violations->count() > 0) {
  104. $event->getExceptions()->add(new WriteConstraintViolationException($violations, $command->getPath()));
  105. }
  106. }
  107. }
  109. /**
  110. * @return array<string, mixed>
  111. */
  112. private function findShippingMethod(string $shippingMethodId): array
  113. {
  114. $shippingMethod = $this->connection->executeQuery(
  115. 'SELECT `tax_type`, `tax_id` FROM `shipping_method` WHERE `id` = :id',
  116. ['id' => $shippingMethodId]
  117. );
  119. return $shippingMethod->fetchAssociative() ?: [];
  120. }
  122. /**
  123. * @param array<string, mixed> $parameters
  124. */
  125. private function buildViolation(
  126. string $messageTemplate,
  127. array $parameters,
  128. string $propertyPath,
  129. string $invalidValue,
  130. string $code
  131. ): ConstraintViolationInterface {
  132. return new ConstraintViolation(
  133. str_replace(array_keys($parameters), array_values($parameters), $messageTemplate),
  134. $messageTemplate,
  135. $parameters,
  136. null,
  137. $propertyPath,
  138. $invalidValue,
  139. null,
  140. $code
  141. );
  142. }
  144. /**
  145. * Gets a value from an array. It also does clean checks if
  146. * the key is set, and also provides the option for default values.
  147. *
  148. * @param array<string, mixed> $data the data array
  149. * @param string $key the requested key in the array
  150. * @param array<string, mixed> $dbRow the db row of from the database
  151. *
  152. * @return mixed the object found in the key, or the default value
  153. */
  154. private function getValue(array $data, string $key, array $dbRow)
  155. {
  156. // try in our actual data set
  157. if (isset($data[$key])) {
  158. return $data[$key];
  159. }
  161. // try in our db row fallback
  162. if (isset($dbRow[$key])) {
  163. return $dbRow[$key];
  164. }
  166. // use default
  167. return null;
  168. }
  169. }