OrderRefundCreationArguments.php 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\SalesInventory\Model\Plugin\Order\Validation;
  7. use Magento\Sales\Api\Data\CreditmemoCommentCreationInterface;
  8. use Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface;
  9. use Magento\Sales\Api\Data\CreditmemoInterface;
  10. use Magento\Sales\Api\Data\OrderInterface;
  11. use Magento\Sales\Model\Order\Validation\RefundOrderInterface;
  12. use Magento\SalesInventory\Model\Order\ReturnValidator;
  13. use Magento\Sales\Model\ValidatorResultInterface;
  14. /**
  15. * Class OrderRefundCreationArguments
  16. */
  17. class OrderRefundCreationArguments
  18. {
  19. /**
  20. * @var ReturnValidator
  21. */
  22. private $returnValidator;
  23. /**
  24. * OrderRefundCreationArguments constructor.
  25. * @param ReturnValidator $returnValidator
  26. */
  27. public function __construct(
  28. ReturnValidator $returnValidator
  29. ) {
  30. $this->returnValidator = $returnValidator;
  31. }
  32. /**
  33. * @param RefundOrderInterface $refundOrderValidator
  34. * @param ValidatorResultInterface $validationResults
  35. * @param OrderInterface $order
  36. * @param CreditmemoInterface $creditmemo
  37. * @param array $items
  38. * @param bool $notify
  39. * @param bool $appendComment
  40. * @param CreditmemoCommentCreationInterface|null $comment
  41. * @param CreditmemoCreationArgumentsInterface|null $arguments
  42. * @return ValidatorResultInterface
  43. * @SuppressWarnings(PHPMD.UnusedFormalParameter)
  44. */
  45. public function afterValidate(
  46. RefundOrderInterface $refundOrderValidator,
  47. ValidatorResultInterface $validationResults,
  48. OrderInterface $order,
  49. CreditmemoInterface $creditmemo,
  50. array $items = [],
  51. $notify = false,
  52. $appendComment = false,
  53. CreditmemoCommentCreationInterface $comment = null,
  54. CreditmemoCreationArgumentsInterface $arguments = null
  55. ) {
  56. if ($this->isReturnToStockItems($arguments)) {
  57. return $validationResults;
  58. }
  59. $returnToStockItems = $arguments->getExtensionAttributes()->getReturnToStockItems();
  60. $validationMessage = $this->returnValidator->validate($returnToStockItems, $creditmemo);
  61. if ($validationMessage) {
  62. $validationResults->addMessage($validationMessage);
  63. }
  64. return $validationResults;
  65. }
  66. /**
  67. * @param CreditmemoCreationArgumentsInterface|null $arguments
  68. * @return bool
  69. */
  70. private function isReturnToStockItems($arguments)
  71. {
  72. return $arguments === null
  73. || $arguments->getExtensionAttributes() === null
  74. || $arguments->getExtensionAttributes()->getReturnToStockItems() === null;
  75. }
  76. }