RefundInvoice Class Reference

Inheritance diagram for RefundInvoice:

Public Member Functions
	__construct (ResourceConnection $resourceConnection, OrderStateResolverInterface $orderStateResolver, OrderRepositoryInterface $orderRepository, InvoiceRepositoryInterface $invoiceRepository, RefundInvoiceValidator $validator, CreditmemoRepositoryInterface $creditmemoRepository, RefundAdapterInterface $refundAdapter, CreditmemoDocumentFactory $creditmemoDocumentFactory, NotifierInterface $notifier, OrderConfig $config, LoggerInterface $logger)
	execute ( $invoiceId, array $items=[], $isOnline=false, $notify=false, $appendComment=false, \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface $comment=null, \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface $arguments=null)

Detailed Description

Class RefundInvoice @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file RefundInvoice.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resourceConnection,
		OrderStateResolverInterface	$orderStateResolver,
		OrderRepositoryInterface	$orderRepository,
		InvoiceRepositoryInterface	$invoiceRepository,
		RefundInvoiceValidator	$validator,
		CreditmemoRepositoryInterface	$creditmemoRepository,
		RefundAdapterInterface	$refundAdapter,
		CreditmemoDocumentFactory	$creditmemoDocumentFactory,
		NotifierInterface	$notifier,
		OrderConfig	$config,
		LoggerInterface	$logger
	)

RefundInvoice constructor.

Parameters

ResourceConnection	$resourceConnection
OrderStateResolverInterface	$orderStateResolver
OrderRepositoryInterface	$orderRepository
InvoiceRepositoryInterface	$invoiceRepository
RefundInvoiceValidator	$validator
CreditmemoRepositoryInterface	$creditmemoRepository
RefundAdapterInterface	$refundAdapter
CreditmemoDocumentFactory	$creditmemoDocumentFactory
NotifierInterface	$notifier
OrderConfig	$config
LoggerInterface	$logger	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 98 of file RefundInvoice.php.

      {
        $this->resourceConnection = $resourceConnection;
        $this->orderStateResolver = $orderStateResolver;
        $this->orderRepository = $orderRepository;
        $this->invoiceRepository = $invoiceRepository;
        $this->validator = $validator;
        $this->creditmemoRepository = $creditmemoRepository;
        $this->refundAdapter = $refundAdapter;
        $this->creditmemoDocumentFactory = $creditmemoDocumentFactory;
        $this->notifier = $notifier;
        $this->config = $config;
        $this->logger = $logger;
    }

Member Function Documentation

execute()

execute	(		$invoiceId,
		array	$items = [],
			$isOnline = false,
			$notify = false,
			$appendComment = false,
		\Magento\Sales\Api\Data\CreditmemoCommentCreationInterface	$comment = null,
		\Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface	$arguments = null
	)

Create refund for invoice

Parameters

int	$invoiceId

Implements RefundInvoiceInterface.

Definition at line 127 of file RefundInvoice.php.

      {
        $connection = $this->resourceConnection->getConnection('sales');
        $invoice = $this->invoiceRepository->get($invoiceId);
        $order = $this->orderRepository->get($invoice->getOrderId());
        $creditmemo = $this->creditmemoDocumentFactory->createFromInvoice(
            $invoice,
            $items,
            $comment,
            ($appendComment && $notify),
            $arguments
        );

        $validationMessages = $this->validator->validate(
            $invoice,
            $order,
            $creditmemo,
            $items,
            $isOnline,
            $notify,
            $appendComment,
            $comment,
            $arguments
        );
        if ($validationMessages->hasMessages()) {
            throw new \Magento\Sales\Exception\DocumentValidationException(
                __("Creditmemo Document Validation Error(s):\n" . implode("\n", $validationMessages->getMessages()))
            );
        }
        $connection->beginTransaction();
        try {
            $creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
            $order->setCustomerNoteNotify($notify);
            $order = $this->refundAdapter->refund($creditmemo, $order, $isOnline);
            $order->setState(
                $this->orderStateResolver->getStateForOrder($order, [])
            );
            $order->setStatus($this->config->getStateDefaultStatus($order->getState()));
            if (!$isOnline) {
                $invoice->setIsUsedForRefund(true);
                $invoice->setBaseTotalRefunded(
                    $invoice->getBaseTotalRefunded() + $creditmemo->getBaseGrandTotal()
                );
            }
            $this->invoiceRepository->save($invoice);
            $order = $this->orderRepository->save($order);
            $creditmemo = $this->creditmemoRepository->save($creditmemo);
            $connection->commit();
        } catch (\Exception $e) {
            $this->logger->critical($e);
            $connection->rollBack();
            throw new \Magento\Sales\Exception\CouldNotRefundException(
                __('Could not save a Creditmemo, see error log for details')
            );
        }
        if ($notify) {
            if (!$appendComment) {
                $comment = null;
            }
            $this->notifier->notify($order, $creditmemo, $comment);
        }

        return $creditmemo->getEntityId();
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales/Model/RefundInvoice.php