spatie/checkout

A simple e-commerce checkout helper for Laravel 5

2.0.3 2016-12-14 23:28 UTC

This package is auto-updated.

Last update: 2020-08-26 08:20:49 UTC


README

Build Status Latest Stable Version StyleCI License

When building a checkout process for a webshop, you likely discovery a need to store the id of a newly created order in a session. This Laravel package provides a clean way to work the order id in the session.

Support us

Learn how to create a package like this one, by watching our premium video course:

Laravel Package training

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

The best postcards will get published on the open source page on our website.

Installation

This package can be installed through Composer.

composer require spatie/checkout

There is a service provider you can make use of.

// app/config/app.php

'providers' => [
    '...',
    'Spatie\Checkout\CheckoutServiceProvider'
];

This package also comes with a facade, which provides an easy way to use this class.

// app/config/app.php

'aliases' => array(
	...
	'Checkout' => 'Spatie\Checkout\CheckoutFacade',
)

Usage

You can store the order id using this method:

    Checkout::setCurrentOrderId($yourOrderId);

Your order id will be stored in Laravel's session store.

You can retrieve the value with:

    Checkout::getCurrentOrderId();

These methods are also provided:

  • Checkout::clearCurrentOrderId(): Forget the previously stored value.
  • Checkout::isCurrentOrderId($orderId): Convenient method to determine if the given orderId is equal to the value stored with the previous call to setCurrentOrderId.