How is \Magento\Sales\Model\Order\Invoice.::capture() implemented and used?

dmitrii_fediuk · May 9, 2016, 12:00pm

Implementation

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Invoice.php#L334-L346


/**
 * Capture invoice
 *
 * @return $this
 */
public function capture()
{
    $this->getOrder()->getPayment()->capture($this);
    if ($this->getIsPaid()) {
        $this->pay();
    }
    return $this;
}

Usages

1. \Magento\Sales\Model\Order\Invoice.::register()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Invoice.php#L599-L608


$captureCase = $this->getRequestedCaptureCase();
if ($this->canCapture()) {
    if ($captureCase) {
        if ($captureCase == self::CAPTURE_ONLINE) {
            $this->capture();
        } elseif ($captureCase == self::CAPTURE_OFFLINE) {
            $this->setCanVoidFlag(false);
            $this->pay();
        }
    }

2. \Magento\Sales\Model\Order\Payment::_invoice()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment.php#L521-L538


/**
 * Create new invoice with maximum qty for invoice for each item
 * register this invoice and capture
 *
 * @return Invoice
 */
protected function _invoice()
{
    $invoice = $this->getOrder()->prepareInvoice();


    $invoice->register();
    if ($this->getMethodInstance()->canCapture()) {
        $invoice->capture();
    }


    $this->getOrder()->addRelatedObject($invoice);
    return $invoice;
}

3. \Magento\Sales\Model\Order\Payment\Operations\AbstractOperation::invoice()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Order/Payment/Operations/AbstractOperation.php#L56-L75


/**
 * Create new invoice with maximum qty for invoice for each item
 * register this invoice and capture
 *
 * @param OrderPaymentInterface $payment
 * @return Invoice
 */
protected function invoice(OrderPaymentInterface $payment)
{
    /** @var Invoice $invoice */
    $invoice = $payment->getOrder()->prepareInvoice();


    $invoice->register();
    if ($payment->getMethodInstance()->canCapture()) {
        $invoice->capture();
    }


    $payment->getOrder()->addRelatedObject($invoice);
    return $invoice;
}

4. \Magento\Sales\Model\Service\InvoiceService::setCapture()

https://github.com/magento/magento2/blob/ffea3cd/app/code/Magento/Sales/Model/Service/InvoiceService.php#L90-L96