InvoiceOrder Class Reference

Inheritance diagram for InvoiceOrder:

Public Member Functions
	__construct (ResourceConnection $resourceConnection, OrderRepositoryInterface $orderRepository, InvoiceDocumentFactory $invoiceDocumentFactory, PaymentAdapterInterface $paymentAdapter, OrderStateResolverInterface $orderStateResolver, OrderConfig $config, InvoiceRepository $invoiceRepository, InvoiceOrderValidator $invoiceOrderValidator, NotifierInterface $notifierInterface, LoggerInterface $logger)
	execute ( $orderId, $capture=false, array $items=[], $notify=false, $appendComment=false, InvoiceCommentCreationInterface $comment=null, InvoiceCreationArgumentsInterface $arguments=null)
Public Member Functions inherited from InvoiceOrderInterface
	execute ( $orderId, $capture=false, array $items=[], $notify=false, $appendComment=false, \Magento\Sales\Api\Data\InvoiceCommentCreationInterface $comment=null, \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface $arguments=null)

Detailed Description

Class InvoiceOrder @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 27 of file InvoiceOrder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resourceConnection,
		OrderRepositoryInterface	$orderRepository,
		InvoiceDocumentFactory	$invoiceDocumentFactory,
		PaymentAdapterInterface	$paymentAdapter,
		OrderStateResolverInterface	$orderStateResolver,
		OrderConfig	$config,
		InvoiceRepository	$invoiceRepository,
		InvoiceOrderValidator	$invoiceOrderValidator,
		NotifierInterface	$notifierInterface,
		LoggerInterface	$logger
	)

InvoiceOrder constructor.

Parameters

ResourceConnection	$resourceConnection
OrderRepositoryInterface	$orderRepository
InvoiceDocumentFactory	$invoiceDocumentFactory
PaymentAdapterInterface	$paymentAdapter
OrderStateResolverInterface	$orderStateResolver
OrderConfig	$config
InvoiceRepository	$invoiceRepository
InvoiceOrderValidator	$invoiceOrderValidator
NotifierInterface	$notifierInterface
LoggerInterface	$logger	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 93 of file InvoiceOrder.php.

      {
        $this->resourceConnection = $resourceConnection;
        $this->orderRepository = $orderRepository;
        $this->invoiceDocumentFactory = $invoiceDocumentFactory;
        $this->paymentAdapter = $paymentAdapter;
        $this->orderStateResolver = $orderStateResolver;
        $this->config = $config;
        $this->invoiceRepository = $invoiceRepository;
        $this->invoiceOrderValidator = $invoiceOrderValidator;
        $this->notifierInterface = $notifierInterface;
        $this->logger = $logger;
    }

Member Function Documentation

execute()

execute	(		$orderId,
			$capture = false,
		array	$items = [],
			$notify = false,
			$appendComment = false,
		InvoiceCommentCreationInterface	$comment = null,
		InvoiceCreationArgumentsInterface	$arguments = null
	)

Parameters

int	$orderId
bool	$capture
array	$items
bool	$notify
bool	$appendComment
\Magento\Sales\Api\Data\InvoiceCommentCreationInterface | null	$comment
\Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface | null	$arguments

Returns

int

Exceptions

Definition at line 132 of file InvoiceOrder.php.

      {
        $connection = $this->resourceConnection->getConnection('sales');
        $order = $this->orderRepository->get($orderId);
        $invoice = $this->invoiceDocumentFactory->create(
            $order,
            $items,
            $comment,
            ($appendComment && $notify),
            $arguments
        );
        $errorMessages = $this->invoiceOrderValidator->validate(
            $order,
            $invoice,
            $capture,
            $items,
            $notify,
            $appendComment,
            $comment,
            $arguments
        );
        if ($errorMessages->hasMessages()) {
            throw new \Magento\Sales\Exception\DocumentValidationException(
                __("Invoice Document Validation Error(s):\n" . implode("\n", $errorMessages->getMessages()))
            );
        }
        $connection->beginTransaction();
        try {
            $order = $this->paymentAdapter->pay($order, $invoice, $capture);
            $order->setState(
                $this->orderStateResolver->getStateForOrder($order, [OrderStateResolverInterface::IN_PROGRESS])
            );
            $order->setStatus($this->config->getStateDefaultStatus($order->getState()));
            $invoice->setState(\Magento\Sales\Model\Order\Invoice::STATE_PAID);
            $this->invoiceRepository->save($invoice);
            $this->orderRepository->save($order);
            $connection->commit();
        } catch (\Exception $e) {
            $this->logger->critical($e);
            $connection->rollBack();
            throw new \Magento\Sales\Exception\CouldNotInvoiceException(
                __('Could not save an invoice, see error log for details')
            );
        }
        if ($notify) {
            if (!$appendComment) {
                $comment = null;
            }
            $this->notifierInterface->notify($order, $invoice, $comment);
        }
        return $invoice->getEntityId();
    }

---

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

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