CreditmemoFactory Class Reference

Public Member Functions
	__construct (\Magento\Sales\Model\Convert\OrderFactory $convertOrderFactory, \Magento\Tax\Model\Config $taxConfig, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	createByOrder (\Magento\Sales\Model\Order $order, array $data=[])

Protected Member Functions
	canRefundItem ($item, $qtys=[], $invoiceQtysRefundLimits=[])
	canRefundNoDummyItem ($item, $invoiceQtysRefundLimits=[])
	initData ($creditmemo, $data)

Protected Attributes
	$convertor
	$taxConfig
	$unserialize

Detailed Description

Factory class for

See also

\Magento\Sales\Model\Order\Creditmemo

Definition at line 14 of file CreditmemoFactory.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Sales\Model\Convert\OrderFactory	$convertOrderFactory,
		\Magento\Tax\Model\Config	$taxConfig,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

Factory constructor

Parameters

\Magento\Sales\Model\Convert\OrderFactory	$convertOrderFactory
\Magento\Tax\Model\Config	$taxConfig
\Magento\Framework\Serialize\Serializer\Json	$serializer

Definition at line 46 of file CreditmemoFactory.php.

      {
        $this->convertor = $convertOrderFactory->create();
        $this->taxConfig = $taxConfig;
        $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
            \Magento\Framework\Serialize\Serializer\Json::class
        );
    }

Member Function Documentation

canRefundItem()

canRefundItem (   $item,   $qtys = [],   $invoiceQtysRefundLimits = []  )

protected

Check if order item can be refunded

Parameters

\Magento\Sales\Model\Order\Item	$item
array	$qtys
array	$invoiceQtysRefundLimits

Returns

bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 145 of file CreditmemoFactory.php.

    {
        if ($item->isDummy()) {
            if ($item->getHasChildren()) {
                foreach ($item->getChildrenItems() as $child) {
                    if (empty($qtys)) {
                        if ($this->canRefundNoDummyItem($child, $invoiceQtysRefundLimits)) {
                            return true;
                        }
                    } else {
                        if (isset($qtys[$child->getId()]) && $qtys[$child->getId()] > 0) {
                            return true;
                        }
                    }
                }
                return false;
            } elseif ($item->getParentItem()) {
                $parent = $item->getParentItem();
                if (empty($qtys)) {
                    return $this->canRefundNoDummyItem($parent, $invoiceQtysRefundLimits);
                } else {
                    return isset($qtys[$parent->getId()]) && $qtys[$parent->getId()] > 0;
                }
            }
        } else {
            return $this->canRefundNoDummyItem($item, $invoiceQtysRefundLimits);
        }
    }

canRefundNoDummyItem()

canRefundNoDummyItem (   $item,   $invoiceQtysRefundLimits = []  )

protected

Check if no dummy order item can be refunded

Parameters

\Magento\Sales\Model\Order\Item	$item
array	$invoiceQtysRefundLimits

Returns

bool

Definition at line 181 of file CreditmemoFactory.php.

    {
        if ($item->getQtyToRefund() < 0) {
            return false;
        }
        if (isset($invoiceQtysRefundLimits[$item->getId()])) {
            return $invoiceQtysRefundLimits[$item->getId()] > 0;
        }
        return true;
    }

createByOrder()

createByOrder	(	\Magento\Sales\Model\Order	$order,
		array	$data = []
	)

Prepare order creditmemo based on order items and requested params

Parameters

\Magento\Sales\Model\Order	$order
array	$data

Returns

Creditmemo

Definition at line 65 of file CreditmemoFactory.php.

    {
        $totalQty = 0;
        $creditmemo = $this->convertor->toCreditmemo($order);
        $qtyList = isset($data['qtys']) ? $data['qtys'] : [];

        foreach ($order->getAllItems() as $orderItem) {
            if (!$this->canRefundItem($orderItem, $qtyList)) {
                continue;
            }

            $item = $this->convertor->itemToCreditmemoItem($orderItem);
            $qty = $this->getQtyToRefund($orderItem, $qtyList);
            $totalQty += $qty;
            $item->setQty($qty);
            $creditmemo->addItem($item);
        }
        $creditmemo->setTotalQty($totalQty);

        $this->initData($creditmemo, $data);

        $creditmemo->collectTotals();
        return $creditmemo;
    }

initData()

initData (   $creditmemo,   $data  )

protected

Initialize creditmemo state based on requested parameters

Parameters

Creditmemo	$creditmemo
array	$data

Returns

void

Definition at line 199 of file CreditmemoFactory.php.

    {
        if (isset($data['shipping_amount'])) {
            $creditmemo->setBaseShippingAmount((double)$data['shipping_amount']);
        }
        if (isset($data['adjustment_positive'])) {
            $creditmemo->setAdjustmentPositive($data['adjustment_positive']);
        }
        if (isset($data['adjustment_negative'])) {
            $creditmemo->setAdjustmentNegative($data['adjustment_negative']);
        }
    }

Field Documentation

$convertor

$convertor

protected

Definition at line 21 of file CreditmemoFactory.php.

$taxConfig

$taxConfig

protected

Definition at line 26 of file CreditmemoFactory.php.

$unserialize

$unserialize

protected

Definition at line 32 of file CreditmemoFactory.php.

---

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

• vendor/magento/module-sales/Model/Order/CreditmemoFactory.php