-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PISHPS-314: Added refund credit notes (#835)
- Loading branch information
1 parent
064e649
commit 1edeafe
Showing
10 changed files
with
574 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
|
|
||
| namespace Kiener\MolliePayments\Service\Refund\Exceptions; | ||
|
|
||
| class CreditNoteException extends \Exception | ||
| { | ||
| public const CODE_ADDING_CREDIT_NOTE_LINE_ITEMS = 1; | ||
| public const CODE_REMOVING_CREDIT_NOTE_LINE_ITEMS = 2; | ||
| final private function __construct(string $message, int $code) | ||
| { | ||
| parent::__construct($message, $code); | ||
| } | ||
|
|
||
| public static function forAddingLineItems(string $message): CreditNoteException | ||
| { | ||
| return new self($message, self::CODE_ADDING_CREDIT_NOTE_LINE_ITEMS); | ||
| } | ||
|
|
||
| public static function forRemovingLineItems(string $message): CreditNoteException | ||
| { | ||
| return new self($message, self::CODE_REMOVING_CREDIT_NOTE_LINE_ITEMS); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
|
|
||
| namespace Kiener\MolliePayments\Service\Refund; | ||
|
|
||
| use Kiener\MolliePayments\Service\Refund\Exceptions\CreditNoteException; | ||
| use Kiener\MolliePayments\Service\SettingsService; | ||
| use Psr\Log\LoggerInterface; | ||
| use Shopware\Core\Checkout\Cart\LineItem\LineItem; | ||
| use Shopware\Core\Checkout\Cart\Price\Struct\CalculatedPrice; | ||
| use Shopware\Core\Checkout\Cart\Price\Struct\QuantityPriceDefinition; | ||
| use Shopware\Core\Checkout\Cart\Tax\Struct\CalculatedTaxCollection; | ||
| use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemEntity; | ||
| use Shopware\Core\Checkout\Order\OrderEntity; | ||
| use Shopware\Core\Framework\Context; | ||
| use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository; | ||
| use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria; | ||
| use Shopware\Core\Framework\Uuid\Uuid; | ||
|
|
||
| class RefundCreditNoteService | ||
| { | ||
| /** | ||
| * @var EntityRepository | ||
| */ | ||
| private $orderRepository; | ||
|
|
||
| /** | ||
| * @var EntityRepository | ||
| */ | ||
| private $orderLineItemRepository; | ||
|
|
||
| /** | ||
| * @var bool | ||
| */ | ||
| private $enabled; | ||
|
|
||
| /** | ||
| * @var string | ||
| */ | ||
| private $prefix; | ||
|
|
||
| /** | ||
| * @var string | ||
| */ | ||
| private $suffix; | ||
|
|
||
| /** | ||
| * @var LoggerInterface | ||
| */ | ||
| private $logger; | ||
|
|
||
| public function __construct( | ||
| EntityRepository $orderRepository, | ||
| EntityRepository $orderLineItemRepository, | ||
| SettingsService $settingsService, | ||
| LoggerInterface $logger | ||
| ) { | ||
| $this->orderRepository = $orderRepository; | ||
| $this->orderLineItemRepository = $orderLineItemRepository; | ||
| $settings = $settingsService->getSettings(); | ||
| $this->enabled = $settings->isRefundManagerCreateCreditNotesEnabled(); | ||
| $this->prefix = $settings->getRefundManagerCreateCreditNotesPrefix(); | ||
| $this->suffix = $settings->getRefundManagerCreateCreditNotesSuffix(); | ||
| $this->logger = $logger; | ||
| } | ||
|
|
||
| /** | ||
| * @param array<int|string, array{id: string}> $lineItems | ||
| * @throws CreditNoteException | ||
| */ | ||
| public function addCreditNoteToOrder(string $orderId, string $refundId, array $lineItems, Context $context): void | ||
| { | ||
| if (!$this->enabled) { | ||
| $this->logger->debug('Credit note creation is disabled'); | ||
| return; | ||
| } | ||
|
|
||
| if (empty($orderId) || empty($refundId)) { | ||
| throw CreditNoteException::forAddingLineItems(sprintf('OrderId or RefundId is empty. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| if (empty($lineItems)) { | ||
| throw CreditNoteException::forAddingLineItems(sprintf('No line items found for credit note. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| $data = ['id' => $orderId, 'lineItems' => []]; | ||
|
|
||
| foreach ($lineItems as ['id' => $lineItemId]) { | ||
| $lineItem = $this->orderLineItemRepository->search(new Criteria([$lineItemId]), $context)->first(); | ||
| if (!$lineItem instanceof OrderLineItemEntity) { | ||
| continue; | ||
| } | ||
| $price = $lineItem->getPrice(); | ||
| if (!$price instanceof CalculatedPrice) { | ||
| continue; | ||
| } | ||
| $taxRules = $price->getTaxRules(); | ||
| $totalPrice = $lineItem->getTotalPrice(); | ||
| $quantity = $lineItem->getQuantity(); | ||
| if ($totalPrice <= 0 || $quantity <= 0) { | ||
| continue; | ||
| } | ||
| $unitPrice = round($totalPrice / $quantity, 2); | ||
| $totalPrice *= -1; | ||
| $unitPrice *= -1; | ||
| $data['lineItems'][] = [ | ||
| 'id' => Uuid::fromStringToHex($lineItemId), | ||
| 'identifier' => Uuid::fromStringToHex($lineItem->getIdentifier()), | ||
| 'quantity' => $quantity, | ||
| 'label' => sprintf('%s%s%s', $this->prefix, $lineItem->getLabel(), $this->suffix), | ||
| 'type' => LineItem::CREDIT_LINE_ITEM_TYPE, | ||
| 'price' => new CalculatedPrice($unitPrice, $totalPrice, new CalculatedTaxCollection(), $taxRules), | ||
| 'priceDefinition' => new QuantityPriceDefinition($totalPrice, $taxRules, $quantity), | ||
| 'customFields' => [ | ||
| 'mollie_payments' => [ | ||
| 'type' => 'refund', | ||
| 'refundId' => $refundId, | ||
| 'lineItemId' => $lineItemId | ||
| ], | ||
| ], | ||
| ]; | ||
| } | ||
|
|
||
| if (empty($data['lineItems'])) { | ||
| throw CreditNoteException::forAddingLineItems(sprintf('No credit note line items found for order. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| $this->logger->debug('Adding credit note to order', ['orderId' => $orderId, 'refundId' => $refundId, 'lineItems' => $data['lineItems']]); | ||
| $this->orderRepository->upsert([$data], $context); | ||
| } | ||
|
|
||
| /** | ||
| * @throws CreditNoteException | ||
| */ | ||
| public function cancelCreditNoteToOrder(string $orderId, string $refundId, Context $context): void | ||
| { | ||
| if (empty($orderId) || empty($refundId)) { | ||
| throw CreditNoteException::forRemovingLineItems(sprintf('OrderId or RefundId is empty. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| $criteria = new Criteria([$orderId]); | ||
| $criteria->addAssociation('lineItems'); | ||
| $searchResult = $this->orderRepository->search($criteria, $context); | ||
| $order = $searchResult->first(); | ||
|
|
||
| if (!$order instanceof OrderEntity) { | ||
| throw CreditNoteException::forRemovingLineItems(sprintf('Order not found. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| $lineItems = $order->getLineItems(); | ||
|
|
||
| if ($lineItems === null) { | ||
| throw CreditNoteException::forRemovingLineItems(sprintf('No line items found for order. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| $ids = []; | ||
| foreach ($lineItems as $lineItem) { | ||
| /** @var OrderLineItemEntity $lineItem */ | ||
| $customFields = $lineItem->getCustomFields(); | ||
| if (!isset($customFields['mollie_payments'], $customFields['mollie_payments']['type']) || $customFields['mollie_payments']['type'] !== 'refund') { | ||
| continue; | ||
| } | ||
|
|
||
| $lineItemRefundId = $customFields['mollie_payments']['refundId']; | ||
| if ($lineItemRefundId !== $refundId) { | ||
| continue; | ||
| } | ||
|
|
||
| $ids[] = ['id' => $lineItem->getId()]; | ||
| } | ||
|
|
||
| if (empty($ids)) { | ||
| throw CreditNoteException::forRemovingLineItems(sprintf('No credit note line items found for order. OrderID: %s RefundID: %s', $orderId, $refundId)); | ||
| } | ||
|
|
||
| $this->orderLineItemRepository->delete($ids, $context); | ||
| } | ||
| } |
Oops, something went wrong.