You're viewing the documentation of an older Simple Commerce version. Consider upgrading to the latest for new features and bug fixes.

Events can be useful if you need to listen out for when certain things in your application happen.

Simple Commerce provides a couple of events to help make your life easier.

Listening for events

First, you'll need a Listener class. You can generate one by running php artisan make:listener NameOfListener. It'll generate a file in App\Listeners.

In the handle function of your event listener, that's where you write your logic that you need to happen when a certain event is triggered.

class NameOfListener
{
    public function handle(NameOfEvent $event)
    {
        //
    }
}

Before your listener will actually listen to an event, you need to hook it up. You can do this in your EventServiceProvider, located in App\Providers.

protected $listen = [
	NameOfEvent::class => [
    	NameOfListener::class,
    ],
];

And there you go, you have a listener listening to an event!

For more documentation around events and event listeners, consider reading the Laravel documentation.

Available events

CartCompleted

DoubleThreeDigital\SimpleCommerce\Events\CartCompleted

This event is fired when an order/cart is complete and has been paid, usually after checking out.

public function handle(CartCompleted $event)
{
	$event->cart;
  	$event->order;
}

CartSaved

DoubleThreeDigital\SimpleCommerce\Events\CartSaved

This event is fired when an order/cart has been saved.

public function handle(CartSaved $event)
{
	$event->cart;
}

CartUpdated

DoubleThreeDigital\SimpleCommerce\Events\CartUpdated

I'd recommend you use the CartSaved event instead. The CartUpdated will be deprecated in future versions.

This event is fired when an order/cart has been saved.

public function handle(CartUpdated $event)
{
	$event->cart;
}

CouponRedeemed

DoubleThreeDigital\SimpleCommerce\Events\CouponRedeemed

This event is fired when a customer adds a coupon to their cart/order.

public function handle(CouponRedeemed $event)
{
	$event->coupon;
}

CustomerAddedToCart

DoubleThreeDigital\SimpleCommerce\Events\CustomerAddedToCart

This event is fired when a customer is attached to a cart/order.

public function handle(CustomerAddedToCart $event)
{
	$event->cart;
}

PostCheckout

DoubleThreeDigital\SimpleCommerce\Events\PostCheckout

This event is fired after the checkout process has been completed.

public function handle(PostCheckout $event)
{
	$event->data;
}

PreCheckout

DoubleThreeDigital\SimpleCommerce\Events\PreCheckout

This event is fired before the checkout process begins.

public function handle(PreCheckout $event)
{
	$event->data;
}

ReceiveGatewayWebhook

DoubleThreeDigital\SimpleCommerce\Events\ReceiveGatewayWebhook

This event is fired whenever a webhook request from a gateway is received.

public function handle(ReceiveGatewayWebhook $event)
{
	$event->payload;
}

StockRunOut

DoubleThreeDigital\SimpleCommerce\Events\StockRunOut

This event is fired when the stock for a product has ran out.

public function handle(StockRunOut $event)
{
	$event->product;
    $event->stock;
}

StockRunningLow

DoubleThreeDigital\SimpleCommerce\Events\StockRunningLow

This event is fired when the stock for a product is running low.

public function handle(StockRunningLow $event)
{
	$event->product;
    $event->stock;
}
Last updated 2 days ago Improve this page on GitHub!