How is \Magento\Checkout\Model\Session::getLastRealOrder() implemented and used?

dmitry_fedyuk · May 5, 2016, 6:55am

Context:

Implementation

magento/magento2/blob/981d1f/app/code/Magento/Checkout/Model/Session.php#L465-L481


/**
 * Get order instance based on last order ID
 *
 * @return \Magento\Sales\Model\Order
 */
public function getLastRealOrder()
{
    $orderId = $this->getLastRealOrderId();
    if ($this->_order !== null && $orderId == $this->_order->getIncrementId()) {
        return $this->_order;
    }
    $this->_order = $this->_orderFactory->create();
    if ($orderId) {
        $this->_order->loadByIncrementId($orderId);
    }
    return $this->_order;
}

Details: How is \Magento\Sales\Model\Order::loadByIncrementId() implemented and used?

Usages

1. \Magento\Checkout\Block\Registration::getEmailAddress()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Checkout/Block/Registration.php#L72-L81


/**
 * Retrieve current email address
 *
 * @return string
 * @codeCoverageIgnore
 */
public function getEmailAddress()
{
    return $this->checkoutSession->getLastRealOrder()->getCustomerEmail();
}

2. \Magento\Checkout\Block\Onepage\Success::prepareBlockData()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Checkout/Block/Onepage/Success.php#L78-L98


protected function prepareBlockData()
{
    $order = $this->_checkoutSession->getLastRealOrder();


    $this->addData(
        [
            'is_order_visible' => $this->isVisible($order),
            'view_order_url' => $this->getUrl(
                'sales/order/view/',
                ['order_id' => $order->getEntityId()]
            ),
            'print_url' => $this->getUrl(
                'sales/order/print',
                ['order_id' => $order->getEntityId()]
            ),
            'can_print_order' => $this->isVisible($order),
            'can_view_order'  => $this->canViewOrder($order),
            'order_id'  => $order->getIncrementId()
        ]
    );
}

3. \Magento\Checkout\Model\Session::restoreQuote()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Checkout/Model/Session.php#L483-L503


/**
 * Restore last active quote
 *
 * @return bool True if quote restored successfully, false otherwise
 */
public function restoreQuote()
{
    /** @var \Magento\Sales\Model\Order $order */
    $order = $this->getLastRealOrder();
    if ($order->getId()) {
        try {
            $quote = $this->quoteRepository->get($order->getQuoteId());
            $quote->setIsActive(1)->setReservedOrderId(null);
            $this->quoteRepository->save($quote);
            $this->replaceQuote($quote)->unsLastRealOrderId();
            $this->_eventManager->dispatch('restore_quote', ['order' => $order, 'quote' => $quote]);
            return true;
        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
        }
    }
    return false;

Details: How is \Magento\Checkout\Model\Session::restoreQuote() implemented and used?

4. \Magento\Downloadable\Block\Checkout\Success::orderHasDownloadableProducts()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Downloadable/Block/Checkout/Success.php#L49-L60


/**
 * Return true if order(s) has one or more downloadable products
 *
 * @return bool
 */
private function orderHasDownloadableProducts()
{
    return $this->isVisible($this->_checkoutSession->getLastRealOrder())
            && $this->currentCustomer->getCustomerId()
        ? $this->_checkoutSession->getHasDownloadableProducts(true)
        : false;
}

5. \Magento\Paypal\Helper\Checkout::cancelCurrentOrder()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Paypal/Helper/Checkout.php#L29-L43


/**
 * Cancel last placed order with specified comment message
 *
 * @param string $comment Comment appended to order history
 * @return bool True if order cancelled, false otherwise
 */
public function cancelCurrentOrder($comment)
{
    $order = $this->session->getLastRealOrder();
    if ($order->getId() && $order->getState() != Order::STATE_CANCELED) {
        $order->registerCancellation($comment)->save();
        return true;
    }
    return false;
}

Details: How is \Magento\Paypal\Helper\Checkout::cancelCurrentOrder() implemented and used?

dmitry_fedyuk · May 8, 2017, 2:19pm