 |
VOOZH | about |
|
VOOZH | about |
This document provides a detailed technical overview of Maho's shopping cart and checkout system. It covers the core Quote system that underpins the shopping cart, the process for adding products to the cart, the checkout flow including the one-step checkout UI, shipping and totals calculation, PayPal Express integration, and payment processing mechanics.
This page targets developers who need to understand the implementation details, data flow, and integration points for the shopping cart and checkout functionality.
The shopping cart in Maho is implemented as a Quote, a mutable entity representing the customer's current shopping session. It holds all quote items, addresses, payment info, and totals, and upon order placement converts into an immutable Order entity.
Mage_Checkout_Model_Session maintains the ongoing quote in session storage.Mage_Checkout_Model_Cart offers business logic to add/remove items and interact with the active quote.Mage_Sales_Model_Quote is the main data model for the cart contents and quote data.Mage_Sales_Model_Quote_Address and Mage_Sales_Model_Quote_Payment.QuoteItem associates a product with quantity and custom options.Sources: app/code/core/Mage/Checkout/controllers/CartController.php20-43 app/code/core/Mage/Checkout/Helper/Data.php26-39
When a user adds a product to the cart, the controller initializes the product model, validates the request, and delegates to the cart model to add the product to the quote. Totals are re-calculated and the quote saved. The controller then returns a response, which in modern UX may be a JSON payload for dynamic UI updates.
Sources: app/code/core/Mage/Checkout/controllers/CartController.php173-240
Mage_Sales_Model_Quote ModelThe primary model for cart management encapsulates:
QuoteItem objects.This model handles total collection and validation, including minimum order amount checks on display. For example, the cart controller adds notices if the minimum order amount is not met.
Mage_Checkout_Model_Session manages the lifecycle of the quote in user sessions, providing getQuote() to retrieve the active quote for the session.
The cart controller uses _initProduct() to load the product model for the product ID passed in the request. It validates the product exists and is salable in the current store context before allowing it to be added to the cart.
In the frontend product view template, the productAddToCartForm.submit function asynchronously submits the add-to-cart request using mahoFetch. Upon success, it dynamically updates the mini-cart UI with the new cart contents and quantity:
This enables a smooth user experience without page reloads when adding items to the cart.
Sources: app/design/frontend/base/default/template/catalog/product/view.phtml99-166 app/code/core/Mage/Checkout/controllers/CartController.php173-240
Maho’s checkout flow features an improved One-Step Checkout (OSC) UI that consolidates multiple steps (billing, shipping, shipping method, payment, review) into a single page with dynamic AJAX updates.
OneStepCheckout class manages form submissions and UI updates:
This allows the checkout page to dynamically update as the user enters their data, providing immediate feedback on shipping options, tax, totals, and payment methods without page reloads.
The billing form (co-billing-form) contains typical EAV fields: names, company, street lines, city, region/state, postcode, and VAT number (if enabled). It supports customer address selection or new address entry. app/design/frontend/base/default/template/checkout/onepage/billing.phtml13-95
Sources: public/js/varien/onestepcheckout.js27-202 app/design/frontend/base/default/template/checkout/onepage/billing.phtml13-95
On the cart page, customers can estimate shipping costs by entering shipping address data. This data is saved in the checkout session and applied to the quote’s shipping address for rate calculations and cart totals.
During quote updates, the collectTotals() method aggregates subtotals, shipping, taxes, discounts, and grand totals. The cart controller checks for minimum order amount configuration and adds a user notice if not met, displaying the configured minimum amount.
Tax utilities in Mage_Checkout_Helper_Data assist in formatting prices with and without tax for display purposes.
The mini-cart widget in the header shows a condensed view of cart contents and updates dynamically via AJAX when the cart changes. It also uses an offcanvas drawer to slide out the cart details for quick access.
mahoFetch AJAX calls.PayPal Express is integrated as an alternative checkout flow.
This diagram illustrates associations between user interface components, relevant controllers, and core models involved in shopping cart and checkout.
Mage_Checkout_CartController for cart actions including adding products and cart display. app/code/core/Mage/Checkout/controllers/CartController.php13-167Mage_Sales_Model_Quote.This concludes the technical overview of Maho's Shopping Cart and Checkout system.
Refresh this wiki