InvoiceService Class Reference

Inheritance diagram for InvoiceService:

Public Member Functions
	__construct (\Magento\Sales\Api\InvoiceRepositoryInterface $repository, \Magento\Sales\Api\InvoiceCommentRepositoryInterface $commentRepository, \Magento\Framework\Api\SearchCriteriaBuilder $criteriaBuilder, \Magento\Framework\Api\FilterBuilder $filterBuilder, \Magento\Sales\Model\Order\InvoiceNotifier $notifier, \Magento\Sales\Api\OrderRepositoryInterface $orderRepository, \Magento\Sales\Model\Convert\Order $orderConverter)
	setCapture ($id)
	getCommentsList ($id)
	notify ($id)
	setVoid ($id)
	prepareInvoice (Order $order, array $qtys=[])

Protected Member Functions
	_canInvoiceItem (\Magento\Sales\Api\Data\OrderItemInterface $item, array $qtys=[])
	setInvoiceItemQuantity (\Magento\Sales\Api\Data\InvoiceItemInterface $item, $qty)

Protected Attributes
	$repository
	$commentRepository
	$criteriaBuilder
	$filterBuilder
	$invoiceNotifier
	$orderRepository
	$orderConverter

Detailed Description

Class InvoiceService

Definition at line 14 of file InvoiceService.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Sales\Api\InvoiceRepositoryInterface	$repository,
		\Magento\Sales\Api\InvoiceCommentRepositoryInterface	$commentRepository,
		\Magento\Framework\Api\SearchCriteriaBuilder	$criteriaBuilder,
		\Magento\Framework\Api\FilterBuilder	$filterBuilder,
		\Magento\Sales\Model\Order\InvoiceNotifier	$notifier,
		\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository,
		\Magento\Sales\Model\Convert\Order	$orderConverter
	)

Constructor

Parameters

\Magento\Sales\Api\InvoiceRepositoryInterface	$repository
\Magento\Sales\Api\InvoiceCommentRepositoryInterface	$commentRepository
\Magento\Framework\Api\SearchCriteriaBuilder	$criteriaBuilder
\Magento\Framework\Api\FilterBuilder	$filterBuilder
\Magento\Sales\Model\Order\InvoiceNotifier	$notifier
\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository
\Magento\Sales\Model\Convert\Order	$orderConverter

Definition at line 72 of file InvoiceService.php.

      {
        $this->repository = $repository;
        $this->commentRepository = $commentRepository;
        $this->criteriaBuilder = $criteriaBuilder;
        $this->filterBuilder = $filterBuilder;
        $this->invoiceNotifier = $notifier;
        $this->orderRepository = $orderRepository;
        $this->orderConverter = $orderConverter;
    }

Member Function Documentation

_canInvoiceItem()

_canInvoiceItem ( \Magento\Sales\Api\Data\OrderItemInterface  $item, array  $qtys = []  )

protected

Check if order item can be invoiced.

Parameters

\Magento\Sales\Api\Data\OrderItemInterface	$item
array	$qtys

Returns

bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 204 of file InvoiceService.php.

    {
        if ($item->getLockedDoInvoice()) {
            return false;
        }
        if ($item->isDummy()) {
            if ($item->getHasChildren()) {
                foreach ($item->getChildrenItems() as $child) {
                    if (empty($qtys)) {
                        if ($child->getQtyToInvoice() > 0) {
                            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 $parent->getQtyToInvoice() > 0;
                } else {
                    return isset($qtys[$parent->getId()]) && $qtys[$parent->getId()] > 0;
                }
            }
        } else {
            return $item->getQtyToInvoice() > 0;
        }
    }

getCommentsList()

getCommentsList

(

$id

)

Lists comments for a specified invoice.

Parameters

int

$id

The invoice ID.

Returns

\Magento\Sales\Api\Data\InvoiceCommentSearchResultInterface Invoice comment search result interface.

Implements InvoiceManagementInterface.

Definition at line 101 of file InvoiceService.php.

    {
        $this->criteriaBuilder->addFilters(
            [$this->filterBuilder->setField('parent_id')->setValue($id)->setConditionType('eq')->create()]
        );
        $searchCriteria = $this->criteriaBuilder->create();
        return $this->commentRepository->getList($searchCriteria);
    }

notify()

notify

(

$id

)

Emails a user a specified invoice.

Parameters

int

$id

The invoice ID.

Returns

bool

Implements InvoiceManagementInterface.

Definition at line 113 of file InvoiceService.php.

    {
        $invoice = $this->repository->get($id);
        return $this->invoiceNotifier->notify($invoice);
    }

prepareInvoice()

prepareInvoice	(	Order	$order,
		array	$qtys = []
	)

Creates an invoice based on the order and quantities provided

Parameters

Order	$order
array	$qtys

Returns

\Magento\Sales\Model\Order\Invoice

Exceptions

Definition at line 135 of file InvoiceService.php.

    {
        $invoice = $this->orderConverter->toInvoice($order);
        $totalQty = 0;
        $qtys = $this->prepareItemsQty($order, $qtys);
        foreach ($order->getAllItems() as $orderItem) {
            if (!$this->_canInvoiceItem($orderItem, $qtys)) {
                continue;
            }
            $item = $this->orderConverter->itemToInvoiceItem($orderItem);
            if ($orderItem->isDummy()) {
                $qty = $orderItem->getQtyOrdered() ? $orderItem->getQtyOrdered() : 1;
            } elseif (isset($qtys[$orderItem->getId()])) {
                $qty = (double) $qtys[$orderItem->getId()];
            } elseif (empty($qtys)) {
                $qty = $orderItem->getQtyToInvoice();
            } else {
                $qty = 0;
            }
            $totalQty += $qty;
            $this->setInvoiceItemQuantity($item, $qty);
            $invoice->addItem($item);
        }
        $invoice->setTotalQty($totalQty);
        $invoice->collectTotals();
        $order->getInvoiceCollection()->addItem($invoice);
        return $invoice;
    }

setCapture()

setCapture

(

$id

)

Sets invoice capture.

Parameters

int

$id

Returns

string

Implements InvoiceManagementInterface.

Definition at line 93 of file InvoiceService.php.

    {
        return (bool)$this->repository->get($id)->capture();
    }

setInvoiceItemQuantity()

setInvoiceItemQuantity ( \Magento\Sales\Api\Data\InvoiceItemInterface  $item,   $qty  )

protected

Set quantity to invoice item

Parameters

\Magento\Sales\Api\Data\InvoiceItemInterface	$item
float	$qty

Returns

$this

Exceptions

Check qty availability

Definition at line 244 of file InvoiceService.php.

    {
        $qty = ($item->getOrderItem()->getIsQtyDecimal()) ? (double) $qty : (int) $qty;
        $qty = $qty > 0 ? $qty : 0;

        $qtyToInvoice = sprintf("%F", $item->getOrderItem()->getQtyToInvoice());
        $qty = sprintf("%F", $qty);
        if ($qty > $qtyToInvoice && !$item->getOrderItem()->isDummy()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('We found an invalid quantity to invoice item "%1".', $item->getName())
            );
        }

        $item->setQty($qty);

        return $this;
    }

setVoid()

setVoid

(

$id

)

Voids a specified invoice.

Parameters

int

$id

The invoice ID.

Returns

bool

Implements InvoiceManagementInterface.

Definition at line 122 of file InvoiceService.php.

    {
        return (bool)$this->repository->get($id)->void();
    }

Field Documentation

$commentRepository

$commentRepository

protected

Definition at line 28 of file InvoiceService.php.

$criteriaBuilder

$criteriaBuilder

protected

Definition at line 35 of file InvoiceService.php.

$filterBuilder

$filterBuilder

protected

Definition at line 42 of file InvoiceService.php.

$invoiceNotifier

$invoiceNotifier

protected

Definition at line 49 of file InvoiceService.php.

$orderConverter

$orderConverter

protected

Definition at line 59 of file InvoiceService.php.

$orderRepository

$orderRepository

protected

Definition at line 54 of file InvoiceService.php.

$repository

$repository

protected

Definition at line 21 of file InvoiceService.php.

---

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

• vendor/magento/module-sales/Model/Service/InvoiceService.php