QuantityValidator.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Model\Order\Shipment\Validation;
  7. use Magento\Framework\Exception\NoSuchEntityException;
  8. use Magento\Sales\Api\Data\OrderInterface;
  9. use Magento\Sales\Api\Data\OrderItemInterface;
  10. use Magento\Sales\Api\Data\ShipmentInterface;
  11. use Magento\Sales\Api\OrderRepositoryInterface;
  12. use Magento\Sales\Exception\DocumentValidationException;
  13. use Magento\Sales\Model\Order\Item;
  14. use Magento\Sales\Model\ValidatorInterface;
  15. /**
  16. * Class QuantityValidator
  17. */
  18. class QuantityValidator implements ValidatorInterface
  19. {
  20. /**
  21. * @var OrderRepositoryInterface
  22. */
  23. private $orderRepository;
  24. /**
  25. * InvoiceValidator constructor.
  26. * @param OrderRepositoryInterface $orderRepository
  27. */
  28. public function __construct(
  29. OrderRepositoryInterface $orderRepository
  30. ) {
  31. $this->orderRepository = $orderRepository;
  32. }
  33. /**
  34. * @param ShipmentInterface $entity
  35. * @return array
  36. * @throws DocumentValidationException
  37. * @throws NoSuchEntityException
  38. */
  39. public function validate($entity)
  40. {
  41. if ($entity->getOrderId() === null) {
  42. return [__('Order Id is required for shipment document')];
  43. }
  44. if (empty($entity->getItems())) {
  45. return [__('You can\'t create a shipment without products.')];
  46. }
  47. $messages = [];
  48. $order = $this->orderRepository->get($entity->getOrderId());
  49. $orderItemsById = $this->getOrderItems($order);
  50. $totalQuantity = 0;
  51. foreach ($entity->getItems() as $item) {
  52. if (!isset($orderItemsById[$item->getOrderItemId()])) {
  53. $messages[] = __(
  54. 'The shipment contains product SKU "%1" that is not part of the original order.',
  55. $item->getSku()
  56. );
  57. continue;
  58. }
  59. $orderItem = $orderItemsById[$item->getOrderItemId()];
  60. if (!$this->isQtyAvailable($orderItem, $item->getQty())) {
  61. $messages[] =__(
  62. 'The quantity to ship must not be greater than the unshipped quantity'
  63. . ' for product SKU "%1".',
  64. $orderItem->getSku()
  65. );
  66. } else {
  67. $totalQuantity += $item->getQty();
  68. }
  69. }
  70. if ($totalQuantity <= 0) {
  71. $messages[] = __('You can\'t create a shipment without products.');
  72. }
  73. return $messages;
  74. }
  75. /**
  76. * @param OrderInterface $order
  77. * @return OrderItemInterface[]
  78. */
  79. private function getOrderItems(OrderInterface $order)
  80. {
  81. $orderItemsById = [];
  82. foreach ($order->getItems() as $item) {
  83. $orderItemsById[$item->getItemId()] = $item;
  84. }
  85. return $orderItemsById;
  86. }
  87. /**
  88. * @param Item $orderItem
  89. * @param int $qty
  90. * @return bool
  91. */
  92. private function isQtyAvailable(Item $orderItem, $qty)
  93. {
  94. return $qty <= $orderItem->getQtyToShip() || $orderItem->isDummy(true);
  95. }
  96. }