Refund Class Reference

Inheritance diagram for Refund:

Public Member Functions
	__construct (\Magento\Sales\Api\OrderRepositoryInterface $orderRepository, \Magento\Sales\Api\InvoiceRepositoryInterface $invoiceRepository, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency)
Public Member Functions inherited from RelationInterface
	processRelation (\Magento\Framework\Model\AbstractModel $object)

Protected Member Functions
	prepareOrder (\Magento\Sales\Model\Order\Creditmemo $creditmemo)
	prepareInvoice (\Magento\Sales\Model\Order\Creditmemo $creditmemo)
	preparePayment (\Magento\Sales\Model\Order\Creditmemo $creditmemo)

Protected Attributes
	$orderRepository
	$invoiceRepository
	$priceCurrency

Detailed Description

Class Relation

Deprecated:

100.1.3

Definition at line 15 of file Refund.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository,
		\Magento\Sales\Api\InvoiceRepositoryInterface	$invoiceRepository,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
	)

Parameters

\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository
\Magento\Sales\Api\InvoiceRepositoryInterface	$invoiceRepository
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency

Definition at line 37 of file Refund.php.

      {
        $this->orderRepository = $orderRepository;
        $this->invoiceRepository = $invoiceRepository;
        $this->priceCurrency = $priceCurrency;
    }

Member Function Documentation

prepareInvoice()

prepareInvoice ( \Magento\Sales\Model\Order\Creditmemo  $creditmemo )

protected

Prepare invoice data for refund

Parameters

\Magento\Sales\Model\Order\Creditmemo

$creditmemo

Returns

void

Definition at line 140 of file Refund.php.

    {
        if ($creditmemo->getInvoice()) {
            $creditmemo->getInvoice()->setIsUsedForRefund(true);
            $creditmemo->getInvoice()->setBaseTotalRefunded(
                $creditmemo->getInvoice()->getBaseTotalRefunded() + $creditmemo->getBaseGrandTotal()
            );
            $creditmemo->setInvoiceId($creditmemo->getInvoice()->getId());
        }
    }

prepareOrder()

prepareOrder ( \Magento\Sales\Model\Order\Creditmemo  $creditmemo )

protected

Prepare order data for refund

Parameters

\Magento\Sales\Model\Order\Creditmemo

$creditmemo

Returns

void

Definition at line 74 of file Refund.php.

    {
        $order = $creditmemo->getOrder();
        $baseOrderRefund = $this->priceCurrency->round(
            $order->getBaseTotalRefunded() + $creditmemo->getBaseGrandTotal()
        );
        $orderRefund = $this->priceCurrency->round(
            $order->getTotalRefunded() + $creditmemo->getGrandTotal()
        );
        $order->setBaseTotalRefunded($baseOrderRefund);
        $order->setTotalRefunded($orderRefund);

        $order->setBaseSubtotalRefunded($order->getBaseSubtotalRefunded() + $creditmemo->getBaseSubtotal());
        $order->setSubtotalRefunded($order->getSubtotalRefunded() + $creditmemo->getSubtotal());

        $order->setBaseTaxRefunded($order->getBaseTaxRefunded() + $creditmemo->getBaseTaxAmount());
        $order->setTaxRefunded($order->getTaxRefunded() + $creditmemo->getTaxAmount());
        $order->setBaseDiscountTaxCompensationRefunded(
            $order->getBaseDiscountTaxCompensationRefunded() + $creditmemo->getBaseDiscountTaxCompensationAmount()
        );
        $order->setDiscountTaxCompensationRefunded(
            $order->getDiscountTaxCompensationRefunded() + $creditmemo->getDiscountTaxCompensationAmount()
        );

        $order->setBaseShippingRefunded($order->getBaseShippingRefunded() + $creditmemo->getBaseShippingAmount());
        $order->setShippingRefunded($order->getShippingRefunded() + $creditmemo->getShippingAmount());

        $order->setBaseShippingTaxRefunded(
            $order->getBaseShippingTaxRefunded() + $creditmemo->getBaseShippingTaxAmount()
        );
        $order->setShippingTaxRefunded($order->getShippingTaxRefunded() + $creditmemo->getShippingTaxAmount());

        $order->setAdjustmentPositive($order->getAdjustmentPositive() + $creditmemo->getAdjustmentPositive());
        $order->setBaseAdjustmentPositive(
            $order->getBaseAdjustmentPositive() + $creditmemo->getBaseAdjustmentPositive()
        );

        $order->setAdjustmentNegative($order->getAdjustmentNegative() + $creditmemo->getAdjustmentNegative());
        $order->setBaseAdjustmentNegative(
            $order->getBaseAdjustmentNegative() + $creditmemo->getBaseAdjustmentNegative()
        );

        $order->setDiscountRefunded($order->getDiscountRefunded() + $creditmemo->getDiscountAmount());
        $order->setBaseDiscountRefunded($order->getBaseDiscountRefunded() + $creditmemo->getBaseDiscountAmount());

        if ($creditmemo->getDoTransaction()) {
            $order->setTotalOnlineRefunded($order->getTotalOnlineRefunded() + $creditmemo->getGrandTotal());
            $order->setBaseTotalOnlineRefunded($order->getBaseTotalOnlineRefunded() + $creditmemo->getBaseGrandTotal());
        } else {
            $order->setTotalOfflineRefunded($order->getTotalOfflineRefunded() + $creditmemo->getGrandTotal());
            $order->setBaseTotalOfflineRefunded(
                $order->getBaseTotalOfflineRefunded() + $creditmemo->getBaseGrandTotal()
            );
        }

        $order->setBaseTotalInvoicedCost(
            $order->getBaseTotalInvoicedCost() - $creditmemo->getBaseCost()
        );
    }

preparePayment()

preparePayment ( \Magento\Sales\Model\Order\Creditmemo  $creditmemo )

protected

Prepare payment data for refund

Parameters

\Magento\Sales\Model\Order\Creditmemo

$creditmemo

Returns

void

Definition at line 157 of file Refund.php.

    {
        if (!$creditmemo->getPaymentRefundDisallowed()) {
            $creditmemo->getOrder()->getPayment()->refund($creditmemo);
        }
    }

Field Documentation

$invoiceRepository

$invoiceRepository

protected

Definition at line 25 of file Refund.php.

$orderRepository

$orderRepository

protected

Definition at line 20 of file Refund.php.

$priceCurrency

$priceCurrency

protected

Definition at line 30 of file Refund.php.

---

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

• vendor/magento/module-sales/Model/ResourceModel/Order/Creditmemo/Relation/Refund.php