checkout.md

Checkout

Checkout is one of the most opinionated areas of E-commerce sites. Vanilo's checkout module was designed to be as flexible as possible, and to support all major checkout types:

• One-page
• Accordion
• Multi-page

It is also possible saving incomplete checkouts to the session, DB, cache (redis, memcache), etc.

Checkout Data

Checkout has the following data associated:

• Cart (CheckoutSubject)
• CheckoutState (enum)
• BillPayer
  • Customer data
  • Billing Address (Address)
• Shipping Address (Address)
• Additional data (custom attributes)

Configuration

It is possible to configure the checkout driver. By default, it's the "request" store, which holds the checkout data during the request/validation cycle.

The "session" checkout driver stores the data in the session, therefore it is available even after the shopper navigates away from the checkout page.

To use the session driver in the checkout, set the vanilo.checkout.store.driver config to session:

// config/vanilo.php
return [
    'checkout' => [
        'store' => [
            'driver' => 'session'
        ]
    ]
];

Checkout Forms

For a complete checkout form example refer to the Vanilo Demo repository

Obtain Checkout Instance

There are 3 usual ways you can use to obtain a checkout instance:

1. Use the Checkout Facade

use App\Http\Requests\CheckoutRequest;
use Vanilo\Cart\Facades\Cart;
use Vanilo\Checkout\Facades\Checkout;

public function submit(CheckoutRequest $request)
{
    Checkout::setCart(Cart::model());
    Checkout::update($request->all());
    //...
}

2. Use the vanilo.checkout Service

$checkout = app('vanilo.checkout');
$cart     = app('vanilo.cart');

$checkout->setCart($cart);

3. Let Laravel Container to Inject

Refer to Container Automatic Injection an for more details

use App\Http\Requests\CheckoutRequest;
use Vanilo\Checkout\Contracts\Checkout;
use Vanilo\Cart\Contracts\Cart;
use Vanilo\Order\Contracts\OrderFactory;

class CheckoutController extends Controller
{
    protected $checkout;
    
    // Laravel Container will inject the actual checkout/cart
    // instances bound to their interfaces
    public function __construct(Checkout $checkout, Cart $cart)
    {
        $this->checkout = $checkout;
        $this->checkout->setCart($cart);
    }
    
    // Actions now can use the checkout
}

Create Order From Checkout

Vanilo Framework extends the Order module's factory with a createFromCheckout method that accepts a pre-validated checkout as parameter:

namespace App\Http\Controllers;

use App\Http\Requests\CheckoutRequest;
use Vanilo\Checkout\Contracts\Checkout;
use Vanilo\Cart\Contracts\Cart;
use Vanilo\Order\Contracts\OrderFactory;

class CheckoutController extends Controller
{
    protected $checkout;
    
    public function __construct(Checkout $checkout, Cart $cart)
    {
        $this->checkout = $checkout;
        $this->checkout->setCart($cart);
    }
    
    // CheckoutRequest contains your app's validation rules
    public function submit(CheckoutRequest $request, OrderFactory $orderFactory)
    {
        $this->checkout->update($request->all());
        $order = $orderFactory->createFromCheckout($this->checkout);
        //...        
    }
}

Custom Checkout Attributes

It's possible to store custom attributes with the Checkout.

Custom attributes are arbitrary key-value pairs.

Set custom attribute:

Checkout::setCustomAttribute('gift', 'Unisex T-Shirt L');
// Retrieve custom attribute
echo Checkout::getCustomAttribute('gift');
// "Unisex T-Shirt L"

Retrieve all custom attributes at once:

Checkout::getCustomAttributes();
// [
//   "gift" => "Unisex T-Shirt L",
//   "gdpr_accepted" => true,
// ]

See Vanilo Demo's CheckoutController for a working example.